chore: add TypeScript declarations (.d.ts) for public API - #273
Open
lucas-tortora wants to merge 1 commit into
Open
chore: add TypeScript declarations (.d.ts) for public API#273lucas-tortora wants to merge 1 commit into
lucas-tortora wants to merge 1 commit into
Conversation
2 tasks
mafintosh
reviewed
Jul 21, 2026
| * Options for `node.connect()`. | ||
| * @typedef {Object} ConnectOptions | ||
| * @property {Array<{host: string, port: number}>} [nodes] - Known DHT nodes close to the remote — speeds up connecting. | ||
| * @property {Array<{host: string, port: number}>} [relayAddresses] - Relay server addresses to hole-punch through when a direct connection cannot be established. |
Contributor
There was a problem hiding this comment.
relay addresses are not this, its an internal option to where you can tell the connect which dht nodes the other guy is likely using to relay the handshake the him (if you know)
mafintosh
reviewed
Jul 21, 2026
| * topic. | ||
| * @param {Buffer} target - 32-byte topic buffer to announce under. | ||
| * @param {{publicKey: Buffer, secretKey: Buffer}} keyPair - The Ed25519 key pair to announce with. | ||
| * @param {Array<{host: string, port: number}>} [relayAddresses] - Up to 3 DHT relay node addresses to include in the announcement. |
Contributor
There was a problem hiding this comment.
must be dht relay addresses you use yourself (when making a server), otherwise your connectivity will fail
lucas-tortora
force-pushed
the
chore/add-js-doc
branch
from
July 21, 2026 19:53
b8a188b to
64dc674
Compare
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
9dd6ac4 to
1614fb0
Compare
lucas-tortora
changed the title
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
2 participants
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 standalone
index.d.tsdeclaring the public API — typed signatures, JSDoc-style@param/@returnsdoc comments, and interfaces for option shapes — instead of inline source JSDoc. Wirestypes/filesinpackage.jsonso the declarations publish. This powers generated reference docs in the Pear docs site — keeping docs in sync with source.Companion docs-site PR: holepunchto/pear-docs#315 (merged)