Skip to content

Commit

Permalink
fix(js): Fix reflection in JS API refs (#1426)
Browse files Browse the repository at this point in the history
  • Loading branch information
jacoblee93 authored Jan 16, 2025
1 parent 9e93aae commit b6ca48b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 10 deletions.
10 changes: 1 addition & 9 deletions js/scripts/typedoc-plugin.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,13 @@ const SCRIPT_HTML = `<script>
function shouldRemoveReflection(reflection) {
const kind = reflection.kind;

if (
reflection.parent &&
reflection.name !== "constructor"
) {
if (kind === ReflectionKind.Property) {
return true;
}
}

if (REFLECTION_KINDS_TO_HIDE.find((kindToHide) => kindToHide === kind)) {
if (reflection.name.startsWith("_") || reflection.name.startsWith("ls_")) {
// Remove all reflections which start with an `_` or `ls_` as those are internal
return true;
}
}
return false;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion js/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@
"name": "LangSmith",
"skipErrorChecking": false,
"exclude": ["dist"],
"hostedBaseUrl": "https://docs.smith.langchain.com/reference/js/",
"hostedBaseUrl": "https://docs.smith.langchain.com/reference/js/"
}

0 comments on commit b6ca48b

Please sign in to comment.