fix: add deprecation warning to mplex

libp2p · Sep 11, 2024 · 3b43a37 · 3b43a37
1 parent 6c7bd45
commit 3b43a37
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/stream-multiplexer-mplex/src/index.ts b/packages/stream-multiplexer-mplex/src/index.ts
@@ -106,6 +106,9 @@ class Mplex implements StreamMuxerFactory {
   }
 }
 
+/**
+ * @deprecated mplex is deprecated as it has no flow control. Please use yamux instead.
+ */
 export function mplex (init: MplexInit = {}): (components: MplexComponents) => StreamMuxerFactory {
   return (components) => new Mplex(components, init)
 }