Conversation
src/content/reference/javascript.mdx is generated by scripts/generate-javascript-reference.mjs from the JSON TypeDoc produces for lightpanda-js, the same way the Python SDK page is generated from pdoc: one section per public class, method, property, function, option type and error, with the JSDoc shipped in the package. Session methods list their arguments under them. The javascript-reference workflow regenerates it daily from lightpanda-js main and opens a PR when it changed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a JavaScript SDK page under Reference (
/reference/javascript), the counterpart of the Python SDK page for thelightpandanpm package.scripts/generate-javascript-reference.mjsturns TypeDoc's JSON for lightpanda-js intosrc/content/reference/javascript.mdx, mirroringgenerate-python-reference.py: same anchor style (#toolerror,#session-find-element), internal links checked at generation time, deterministic output. EachSessionmethod lists its arguments under it..github/workflows/javascript-reference.ymlregenerates the page daily from lightpanda-js main and opens a PR when it changed, likepython-reference.yml. TypeDoc's version and settings are pinned in lightpanda-js (typedoc.json), so no browser binary or TypeDoc pin is needed here.34cb6d9.The page matches what the workflow generates from lightpanda-js main, which now includes
34cb6d9.