@libp2p/yamux 8.0.1 → 8.0.2-5cb617ae2

package/src/index.ts

@@ -3,6 +3,8 @@
  *
  * This module is a JavaScript implementation of [Yamux from Hashicorp](https://github.com/hashicorp/yamux/blob/master/spec.md) designed to be used with [js-libp2p](https://github.com/libp2p/js-libp2p).
  *
+ * Formerly published as [`@chainsafe/libp2p-yamux`](https://www.npmjs.com/package/@chainsafe/libp2p-yamux).
+ *
  * @example Configure libp2p with Yamux
  *
  * ```typescript
@@ -19,70 +21,52 @@
  *
  * @example Using the low-level API
  *
- * ```js
+ * ```typescript
  * import { yamux } from '@libp2p/yamux'
- * import { pipe } from 'it-pipe'
- * import { duplexPair } from 'it-pair/duplex'
- * import all from 'it-all'
- *
- * // Connect two yamux muxers to demo basic stream multiplexing functionality
- *
- * const clientMuxer = yamux({
- *   client: true,
- *   onIncomingStream: stream => {
- *     // echo data on incoming streams
- *     pipe(stream, stream)
- *   },
- *   onStreamEnd: stream => {
- *     // do nothing
- *   }
- * })()
- *
- * const serverMuxer = yamux({
- *   client: false,
- *   onIncomingStream: stream => {
- *     // echo data on incoming streams
- *     pipe(stream, stream)
- *   },
- *   onStreamEnd: stream => {
- *     // do nothing
- *   }
- * })()
- *
- * // `p` is our "connections", what we use to connect the two sides
- * // In a real application, a connection is usually to a remote computer
- * const p = duplexPair()
- *
- * // connect the muxers together
- * pipe(p[0], clientMuxer, p[0])
- * pipe(p[1], serverMuxer, p[1])
- *
- * // now either side can open streams
- * const stream0 = clientMuxer.newStream()
- * const stream1 = serverMuxer.newStream()
- *
- * // Send some data to the other side
- * const encoder = new TextEncoder()
- * const data = [encoder.encode('hello'), encoder.encode('world')]
- * pipe(data, stream0)
- *
- * // Receive data back
- * const result = await pipe(stream0, all)
- *
- * // close a stream
- * stream1.close()
- *
- * // close the muxer
- * clientMuxer.close()
+ * import { multiaddrConnectionPair } from '@libp2p/utils'
+ *
+ * // a pair of connected multiaddr connections - in a real application these
+ * // would be the two ends of a network connection
+ * const [outboundConnection, inboundConnection] = multiaddrConnectionPair()
+ *
+ * const clientMuxer = yamux()().createStreamMuxer(outboundConnection)
+ * const serverMuxer = yamux()().createStreamMuxer(inboundConnection)
+ *
+ * // echo incoming data back on the server side
+ * serverMuxer.addEventListener('stream', (evt) => {
+ *   const stream = evt.detail
+ *
+ *   stream.addEventListener('message', (msg) => {
+ *     stream.send(msg.data)
+ *   })
+ * })
+ *
+ * // open a stream from the client and send some data
+ * const stream = await clientMuxer.createStream()
+ *
+ * const received = new Promise<string>((resolve) => {
+ *   stream.addEventListener('message', (msg) => {
+ *     resolve(new TextDecoder().decode(msg.data.subarray()))
+ *   })
+ * })
+ *
+ * stream.send(new TextEncoder().encode('hello world'))
+ *
+ * console.info(await received)
+ * // -> hello world
+ *
+ * await stream.close()
+ * await clientMuxer.close()
+ * await serverMuxer.close()
  * ```
  */
 
-import { Yamux } from './muxer.js'
-import type { YamuxMuxer, YamuxMuxerInit } from './muxer.js'
+import { Yamux } from './muxer.ts'
+import type { YamuxMuxer, YamuxMuxerInit } from './muxer.ts'
 import type { StreamMuxerFactory } from '@libp2p/interface'
 
-export { GoAwayCode } from './frame.js'
-export type { FrameHeader, FrameType } from './frame.js'
+export { GoAwayCode } from './frame.ts'
+export type { FrameHeader, FrameType } from './frame.ts'
 export type { YamuxMuxerInit }
 
 export function yamux (init: YamuxMuxerInit = {}): () => StreamMuxerFactory<YamuxMuxer> {

package/src/muxer.ts

@@ -2,15 +2,15 @@ import { InvalidParametersError, MuxerClosedError, TooManyOutboundProtocolStream
 import { AbstractStreamMuxer, repeatingTask } from '@libp2p/utils'
 import { raceSignal } from 'race-signal'
 import { Uint8ArrayList } from 'uint8arraylist'
-import { defaultConfig, verifyConfig } from './config.js'
-import { Decoder } from './decode.js'
-import { encodeHeader } from './encode.js'
-import { InvalidFrameError, isProtocolError, NotMatchingPingError, UnRequestedPingError } from './errors.js'
-import { Flag, FrameType, GoAwayCode } from './frame.js'
-import { StreamState, YamuxStream } from './stream.js'
-import type { Config } from './config.js'
-import type { Frame } from './decode.js'
-import type { FrameHeader } from './frame.js'
+import { defaultConfig, verifyConfig } from './config.ts'
+import { Decoder } from './decode.ts'
+import { encodeHeader } from './encode.ts'
+import { InvalidFrameError, isProtocolError, NotMatchingPingError, UnRequestedPingError } from './errors.ts'
+import { Flag, FrameType, GoAwayCode } from './frame.ts'
+import { StreamState, YamuxStream } from './stream.ts'
+import type { Config } from './config.ts'
+import type { Frame } from './decode.ts'
+import type { FrameHeader } from './frame.ts'
 import type { AbortOptions, MessageStream, StreamMuxerFactory } from '@libp2p/interface'
 import type { RepeatingTask } from '@libp2p/utils'
 

package/src/stream.ts

@@ -1,11 +1,11 @@
 import { AbstractStream } from '@libp2p/utils'
 import { Uint8ArrayList } from 'uint8arraylist'
-import { INITIAL_STREAM_WINDOW, MAX_STREAM_WINDOW } from './constants.js'
+import { INITIAL_STREAM_WINDOW, MAX_STREAM_WINDOW } from './constants.ts'
 import { isDataFrame } from './decode.ts'
-import { InvalidFrameError, ReceiveWindowExceededError } from './errors.js'
-import { Flag, FrameType, HEADER_LENGTH } from './frame.js'
+import { InvalidFrameError, ReceiveWindowExceededError } from './errors.ts'
+import { Flag, FrameType, HEADER_LENGTH } from './frame.ts'
 import type { Frame } from './decode.ts'
-import type { FrameHeader } from './frame.js'
+import type { FrameHeader } from './frame.ts'
 import type { AbortOptions } from '@libp2p/interface'
 import type { AbstractStreamInit, SendResult } from '@libp2p/utils'
 
@@ -127,7 +127,7 @@ export class YamuxStream extends AbstractStream {
   /**
    * Send a reset message to the remote muxer
    */
-  async sendReset (): Promise<void> {
+  sendReset (): void {
     this.sendFrame({
       type: FrameType.WindowUpdate,
       flag: Flag.RST,

package/dist/typedoc-urls.json

@@ -1,22 +0,0 @@
-{
-  "Config": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.config.Config.html",
-  "./config:Config": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.config.Config.html",
-  "YamuxStreamOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.config.YamuxStreamOptions.html",
-  "./config:YamuxStreamOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.config.YamuxStreamOptions.html",
-  "defaultConfig": "https://libp2p.github.io/js-libp2p/variables/_libp2p_yamux.config.defaultConfig.html",
-  "./config:defaultConfig": "https://libp2p.github.io/js-libp2p/variables/_libp2p_yamux.config.defaultConfig.html",
-  "verifyConfig": "https://libp2p.github.io/js-libp2p/functions/_libp2p_yamux.config.verifyConfig.html",
-  "./config:verifyConfig": "https://libp2p.github.io/js-libp2p/functions/_libp2p_yamux.config.verifyConfig.html",
-  "FrameType": "https://libp2p.github.io/js-libp2p/enums/_libp2p_yamux.index.FrameType.html",
-  "GoAwayCode": "https://libp2p.github.io/js-libp2p/enums/_libp2p_yamux.index.GoAwayCode.html",
-  "FrameHeader": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.index.FrameHeader.html",
-  "YamuxMuxerInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.index.YamuxMuxerInit.html",
-  "yamux": "https://libp2p.github.io/js-libp2p/functions/_libp2p_yamux.index.yamux.html",
-  ".:yamux": "https://libp2p.github.io/js-libp2p/functions/_libp2p_yamux.index.yamux.html",
-  "StreamState": "https://libp2p.github.io/js-libp2p/enums/_libp2p_yamux.stream.StreamState.html",
-  "./stream:StreamState": "https://libp2p.github.io/js-libp2p/enums/_libp2p_yamux.stream.StreamState.html",
-  "YamuxStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_yamux.stream.YamuxStream.html",
-  "./stream:YamuxStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_yamux.stream.YamuxStream.html",
-  "YamuxStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.stream.YamuxStreamInit.html",
-  "./stream:YamuxStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_yamux.stream.YamuxStreamInit.html"
-}