fix: relax and correct types (#144)

Make signal optional since we guard on it anyway

src/handle.js

@@ -13,13 +13,13 @@ const log = Object.assign(debug('mss:handle'), {
 
 /**
  * @typedef {import('./types').DuplexStream<Uint8Array>} DuplexStream
+ * @typedef {import('./types').AbortOptions} AbortOptions
  */
 
 /**
  * @param {DuplexStream} stream
  * @param {string | string[]} protocols
- * @param {object} [options]
- * @param {AbortSignal} options.signal
+ * @param {AbortOptions} [options]
  */
 module.exports = async function handle (stream, protocols, options) {
   protocols = Array.isArray(protocols) ? protocols : [protocols]

src/index.js

@@ -9,6 +9,7 @@ exports.PROTOCOL_ID = PROTOCOL_ID
 
 /**
  * @typedef {import('./types').DuplexStream<Uint8Array>} DuplexStream
+ * @typedef {import('./types').AbortOptions} AbortOptions
  */
 
 class MultistreamSelect {
@@ -63,8 +64,7 @@ exports.Dialer = Dialer
 class Listener extends MultistreamSelect {
   /**
    * @param {string | string[]} protocols
-   * @param {object} [options]
-   * @param {AbortSignal} options.signal
+   * @param {AbortOptions} [options]
    */
   handle (protocols, options) {
     return handle(this._stream, protocols, options)

src/ls.js

@@ -16,12 +16,12 @@ const log = Object.assign(debug('mss:ls'), {
 /**
  * @typedef {import('./types').DuplexStream<Uint8Array>} DuplexStream
  * @typedef {import('bl/BufferList')} BufferList
+ * @typedef {import('./types').AbortOptions} AbortOptions
  */
 
 /**
  * @param {DuplexStream} stream
- * @param {object} [options]
- * @param {AbortSignal} options.signal
+ * @param {AbortOptions} [options]
  */
 module.exports = async function ls (stream, options) {
   const { reader, writer, rest, stream: shakeStream } = handshake(stream)

src/multistream.js

@@ -10,6 +10,7 @@ const { source } = require('abortable-iterator')
 
 /**
  * @typedef {import('it-pushable').Pushable<Uint8Array | BufferList>} Pushable
+ * @typedef {import('./types').AbortOptions} AbortOptions
  */
 
 const NewLine = uint8ArrayFromString('\n')
@@ -46,8 +47,7 @@ async function writeAll (writer, buffers) {
 
 /**
  * @param {AsyncGenerator<Uint8Array | BufferList, void, number>} reader
- * @param {object} [options]
- * @param {AbortSignal} options.signal
+ * @param {AbortOptions} [options]
  */
 async function read (reader, options) {
   let byteLength = 1 // Read single byte chunks until the length is known

src/select.js

@@ -13,14 +13,14 @@ const log = Object.assign(debug('mss:select'), {
 /**
  * @typedef {import('./types').DuplexStream<Uint8Array>} DuplexStream
  * @typedef {import('bl/BufferList')} BufferList
+ * @typedef {import('./types').AbortOptions} AbortOptions
  */
 
 /**
  * @param {DuplexStream} stream
  * @param {string | string[]} protocols
  * @param {string} [protocolId]
- * @param {object} [options]
- * @param {AbortSignal} options.signal
+ * @param {AbortOptions} [options]
  */
 module.exports = async function select (stream, protocols, protocolId, options) {
   protocols = Array.isArray(protocols) ? [...protocols] : [protocols]

src/types.ts

@@ -1,5 +1,12 @@
 
+export interface AbortOptions {
+  signal?: AbortSignal
+}
+
+export type Source<T> = AsyncIterable<T>
+export interface Sink<T> { (source: AsyncIterable<T>): Promise<void> }
+
 export interface DuplexStream<T> {
-  source: AsyncIterable<T>
-  sink: (source: AsyncIterable<T>) => void
+  source: Source<T>
+  sink: Sink<T>
 }