Repository navigation
docs(bare): build the runtime reference from src/bare.d.ts - #418
Closed
lucas-tortora wants to merge 2 commits into
Closed
lucas-tortora wants to merge 2 commits into
lucas-tortora wants to merge 2 commits into
Conversation
Bare 1.35.0 moved its type declarations from npm/index.d.ts to src/bare.d.ts and dropped the API section from the README (holepunchto/bare#239), so the JSDoc there is now the source for the JavaScript API. - gen-bare-docs-states reads src/bare.d.ts and falls back to npm/index.d.ts for older tags, so the doc-state history survives the move. Regenerated the bare-runtime states: new stable 1.35.0 state. - Point the upstream-commits watch at src/bare.d.ts and baseline it at the reviewed commit; the old path no longer exists on main. - runtime.mdx: add Addon.loaded() and the Thread mount option (Since 1.35.0), bundle addons on threads, WebAssembly addons after sealing, bare_module_find() returning void *, and the wasi/wasm32 target macros. Rewrite the maintainer note that still described seal() as missing from the .d.ts. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Preview deployments for pear-docs preview ⚡️
Commit: Deployment ID: Static site name: |
Preview deployments for pear-docs published ⚡️
Commit: Deployment ID: Static site name: |
- mount: 'file:///' lets the bundle serve modules at any file: URL, not read any file; the thread protocol still reaches nothing. Fold the TypeError note into the mount option and give the .bundle sentence a subject. - Bare.platform and Bare.arch return wasi and wasm32 from 1.35.0, the same macros the bare/target.h row lists; the .d.ts unions do not list them yet. - Bump the bare/version.h example string to 1.35.1. - Move the bare_module_find uv_lib_t * history to the end of the paragraph. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This branch was successfully deployed
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
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.
Bare 1.35.0 moved its type declarations from
npm/index.d.tstosrc/bare.d.tsand removed the API section from the README (holepunchto/bare#239). The JSDoc in the new file is now the source for the JavaScript API, andmainatv1.35.1has the identical file.What changed
gen-bare-docs-statesreadssrc/bare.d.tsand falls back tonpm/index.d.tsfor older tags. Without the fallback the tag walk stopped at 1.34.1 and lost all history. Regeneratedbare-runtime-docs-states.json: new stable 1.35.0 state, so<Since v="1.35.0" />validates.bare-runtimenow watchessrc/bare.d.ts(the old path is gone onmain), baselined at3f7cae81, the commit reviewed here.runtime.mdx, checked against the JSDoc and Bare source at v1.35.1:Addon.loaded(url)and theThreadmountoption, both Since 1.35.0.bundlethread source are treated as on disk (#244)Addon.seal()(threat model)bare_module_find()returnsvoid *(wasuv_lib_t *)wasiandwasm32in thebare/target.hmacrosseal()as missing from the.d.tsand the README as an audit sourceNot in this PR
Bare.suspend()/wakeup()clamping oflingeranddeadline(#250) landed onmainafter 1.35.1. It's noted in the maintainer comment to revisit on release.Checks
check:docs-versions,check:doctypes,check:internal-links,check:cross-links, andcheck:bare-c-api --ref v1.35.1pass, and the page compiles as MDX.🤖 Generated with Claude Code