chore: add types for @hyperswarm/secret-stream #34
Conversation
| // TODO: Figure out where those extra fields come from and find more elegant way to represent this | ||
| /** | ||
| * @typedef {Object} NoiseSecretStream | ||
| * @property {Buffer} remotePublicKey | ||
| * @property {number} remotePort | ||
| * @property {string} remoteHost | ||
| * @property {import('net').Socket} rawStream | ||
| * @property {function} end | ||
| * @typedef {import('streamx').Duplex & {remoteAddress: string, remotePort:number}} RawDHTConnectionStream |
There was a problem hiding this comment.
Seth may have an idea of where these come from, but my guess is that it would require even more work to get the proper typings for that to update this
There was a problem hiding this comment.
i think the approach used here makes sense.
| // TODO: Use https://github.com/chm-diederichs/noise-handshake/blob/main/noise.js for specific patterns | ||
| pattern?: string |
There was a problem hiding this comment.
tbh i had no idea how to read those pattern variables in the link provided, so went with string for now
There was a problem hiding this comment.
yeah i think we're unlikely to set the pattern option too, so seems lower priority.
| > extends Duplex< | ||
| any, | ||
| any, | ||
| any, | ||
| any, | ||
| true, | ||
| true, | ||
| DuplexEvents<any, any> & NoiseStreamEvents | ||
| > { |
There was a problem hiding this comment.
is there a more concise way to write this??
achou11
force-pushed
the
ac/secret-stream-types
branch
2 times, most recently
from
33caf88 to
37b4c9d
Compare
lib/discovery/index.js
Outdated
| @@ -889,7 +888,7 @@ export class PeerInfo extends TypedEmitter { | |||
| * @param {Object} options | |||
| * @param {IdentityPublicKeyString} [options.identityPublicKey] | |||
| * @param {('dht'|'mdns')} [options.discoveryType] | |||
| * @param {ConnectionStream} [options.connection] | |||
| * @param {SecretStream<RawConnectionStream>} [options.connection] | |||
There was a problem hiding this comment.
ideally would do some conditional typing to narrow down the RawConnectionStream type based on the discoveryType. not sure how to go about that in TS + JSDoc
There was a problem hiding this comment.
ah, yeah that would be nice. i think we're good for now with SecretStream<RawConnectionStream> in part because ideally at this stage the streams from the two discovery types should be pretty much equivalent.
lib/discovery/index.js
Outdated
| @@ -832,7 +831,7 @@ export class PeerInfo extends TypedEmitter { | |||
| * @typedef {Object} PeerInfoOptions | |||
| * @property {IdentityPublicKeyString} identityPublicKey | |||
| * @property {('dht'|'mdns')} discoveryType | |||
| * @property {ConnectionStream} connection | |||
| * @property {SecretStream<RawConnectionStream>} connection | |||
There was a problem hiding this comment.
ideally would do some conditional typing to narrow down the RawConnectionStream type based on the discoveryType. not sure how to go about that in TS + JSDoc
achou11
force-pushed
the
ac/secret-stream-types
branch
from
68d56e8 to
37b4c9d
Compare
achou11
force-pushed
the
ac/secret-stream-types
branch
from
37b4c9d to
f70d211
Compare
Towards #14
wow i thought this would be easier...
Notes: