Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(js): Fix reflection in JS API refs #1426

Merged
merged 3 commits into from
Jan 16, 2025
Merged

fix(js): Fix reflection in JS API refs #1426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d75a7eb
Use absolute links
jacoblee93 Jan 16, 2025
e7e62e1
Fix reflection
jacoblee93 Jan 16, 2025
0c9828f
Merge branch 'main' of github.com:langchain-ai/langsmith-sdk into jac…
jacoblee93 Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions js/scripts/typedoc-plugin.cjs
View file
Open in desktop
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
View file
Open in desktop
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/"
}
Loading