chore: add JSDoc to public API - #839
Open
lucas-tortora wants to merge 1 commit into
Open
Conversation
2 tasks
Adds a standalone TypeScript declaration file for the public API, wires it up via package.json "types", and ships it in the published "files". Keeping the types in a separate .d.ts (no inline JSDoc) avoids source-file merge conflicts while giving consumers IDE/tsc support. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
lucas-tortora
force-pushed
the
chore/add-js-doc
branch
from
July 27, 2026 14:34
530c350 to
6bb7683
Compare
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 JSDoc to the public API surface: descriptions, typed
@param/@returns,@throwsconditions, and@typedefoption shapes. This powers generated reference docs in the Pear docs site — keeping docs in sync with source. Companion docs-site PR: holepunchto/pear-docs#314