@libp2p/multistream-select 5.1.3 → 5.1.4-f71bc49bd

package/README.md

@@ -1,3 +1,5 @@
+# @libp2p/multistream-select
+
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,6 +9,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 multistream-select is protocol multiplexing per connection/stream. [Full spec here](https://github.com/multiformats/multistream-select)
 
 ## Select a protocol flow

package/dist/src/handle.d.ts

@@ -11,7 +11,7 @@ import type { Duplex } from 'it-stream-types';
  * @returns A stream for the selected protocol and the protocol that was selected from the list of protocols provided to `select`
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { pipe } from 'it-pipe'
  * import * as mss from '@libp2p/multistream-select'
  * import { Mplex } from '@libp2p/mplex'

package/dist/src/handle.js

@@ -15,7 +15,7 @@ import * as multistream from './multistream.js';
  * @returns A stream for the selected protocol and the protocol that was selected from the list of protocols provided to `select`
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { pipe } from 'it-pipe'
  * import * as mss from '@libp2p/multistream-select'
  * import { Mplex } from '@libp2p/mplex'

package/dist/src/select.d.ts

@@ -16,7 +16,7 @@ export interface SelectStream extends Duplex<any, any, any> {
  * @returns A stream for the selected protocol and the protocol that was selected from the list of protocols provided to `select`.
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { pipe } from 'it-pipe'
  * import * as mss from '@libp2p/multistream-select'
  * import { Mplex } from '@libp2p/mplex'

package/dist/src/select.js

@@ -17,7 +17,7 @@ import { PROTOCOL_ID } from './index.js';
  * @returns A stream for the selected protocol and the protocol that was selected from the list of protocols provided to `select`.
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { pipe } from 'it-pipe'
  * import * as mss from '@libp2p/multistream-select'
  * import { Mplex } from '@libp2p/mplex'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/multistream-select",
-  "version": "5.1.3",
+  "version": "5.1.4-f71bc49bd",
   "description": "JavaScript implementation of multistream-select",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/multistream-select#readme",
@@ -47,6 +47,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",
@@ -57,7 +58,7 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@libp2p/interface": "^1.1.3",
+    "@libp2p/interface": "1.1.4-f71bc49bd",
     "it-length-prefixed": "^9.0.4",
     "it-length-prefixed-stream": "^1.1.6",
     "it-stream-types": "^2.0.1",
@@ -65,11 +66,11 @@
     "race-signal": "^1.0.2",
     "uint8-varint": "^2.0.4",
     "uint8arraylist": "^2.4.8",
-    "uint8arrays": "^5.0.1"
+    "uint8arrays": "^5.0.2"
   },
   "devDependencies": {
-    "@libp2p/logger": "^4.0.6",
-    "aegir": "^42.2.3",
+    "@libp2p/logger": "4.0.7-f71bc49bd",
+    "aegir": "^42.2.4",
     "iso-random-stream": "^2.0.2",
     "it-all": "^3.0.4",
     "it-drain": "^3.0.5",

package/src/handle.ts

@@ -18,7 +18,7 @@ import type { Duplex } from 'it-stream-types'
  * @returns A stream for the selected protocol and the protocol that was selected from the list of protocols provided to `select`
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { pipe } from 'it-pipe'
  * import * as mss from '@libp2p/multistream-select'
  * import { Mplex } from '@libp2p/mplex'

package/src/select.ts

@@ -28,7 +28,7 @@ export interface SelectStream extends Duplex<any, any, any> {
  * @returns A stream for the selected protocol and the protocol that was selected from the list of protocols provided to `select`.
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { pipe } from 'it-pipe'
  * import * as mss from '@libp2p/multistream-select'
  * import { Mplex } from '@libp2p/mplex'

package/dist/typedoc-urls.json

@@ -1,9 +0,0 @@
-{
-  "MultistreamSelectInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html",
-  ".:MultistreamSelectInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html",
-  "ProtocolStream": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_multistream_select.ProtocolStream.html",
-  ".:ProtocolStream": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_multistream_select.ProtocolStream.html",
-  "PROTOCOL_ID": "https://libp2p.github.io/js-libp2p/variables/_libp2p_multistream_select.PROTOCOL_ID.html",
-  "handle": "https://libp2p.github.io/js-libp2p/functions/_libp2p_multistream_select.handle.html",
-  "select": "https://libp2p.github.io/js-libp2p/functions/_libp2p_multistream_select.select.html"
-}