@libp2p/interface-internal 0.1.11-cf963694f → 0.1.11-e7167fe52

package/dist/src/registrar/index.d.ts

@@ -1,6 +1,12 @@
 import type { Connection, Stream, Topology } from '@libp2p/interface';
 export interface IncomingStreamData {
+    /**
+     * The stream that has been opened
+     */
     stream: Stream;
+    /**
+     * The connection that the stream was opened on
+     */
     connection: Connection;
 }
 export interface StreamHandler {
@@ -23,7 +29,13 @@ export interface StreamHandlerOptions {
     runOnTransientConnection?: boolean;
 }
 export interface StreamHandlerRecord {
+    /**
+     * The handler that was registered to handle streams opened on the protocol
+     */
     handler: StreamHandler;
+    /**
+     * The options that were used to register the stream handler
+     */
     options: StreamHandlerOptions;
 }
 export interface Registrar {

package/dist/src/registrar/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/registrar/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAErE,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,aAAa,CAAA;IACtB,OAAO,EAAE,oBAAoB,CAAA;CAC9B;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,YAAY,IAAI,MAAM,EAAE,CAAA;IAExB;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/F;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAA;IAEjD;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE/D;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;;OAGG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,EAAE,CAAA;CAC5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/registrar/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAErE,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAA;IAEtB;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAA;CAC9B;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,YAAY,IAAI,MAAM,EAAE,CAAA;IAExB;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/F;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAA;IAEjD;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE/D;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;;OAGG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,EAAE,CAAA;CAC5C"}

package/dist/src/transport-manager/index.d.ts

@@ -1,14 +1,44 @@
 import type { Connection, Listener, Transport } from '@libp2p/interface';
 import type { Multiaddr } from '@multiformats/multiaddr';
 export interface TransportManager {
+    /**
+     * Add a transport to the transport manager
+     */
     add(transport: Transport): void;
+    /**
+     * Dial a multiaddr. Connections returned by this method will not be tracked
+     * by the connection manager so can cause memory leaks. If you need to dial
+     * a multiaddr, you may want to call openConnection on the connection manager
+     * instead.
+     */
     dial(ma: Multiaddr, options?: any): Promise<Connection>;
+    /**
+     * Return all addresses currently being listened on
+     */
     getAddrs(): Multiaddr[];
+    /**
+     * Return all registered transports
+     */
     getTransports(): Transport[];
+    /**
+     * Return all listeners
+     */
     getListeners(): Listener[];
+    /**
+     * Get the transport for a given multiaddr, if one has been configured
+     */
     transportForMultiaddr(ma: Multiaddr): Transport | undefined;
+    /**
+     * Listen on the passed multiaddrs
+     */
     listen(addrs: Multiaddr[]): Promise<void>;
+    /**
+     * Remove a previously configured transport
+     */
     remove(key: string): Promise<void>;
+    /**
+     * Remove all transports
+     */
     removeAll(): Promise<void>;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/src/transport-manager/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAC/B,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACvD,QAAQ,IAAI,SAAS,EAAE,CAAA;IACvB,aAAa,IAAI,SAAS,EAAE,CAAA;IAC5B,YAAY,IAAI,QAAQ,EAAE,CAAA;IAC1B,qBAAqB,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA;IAC3D,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAE/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvD;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IAEvB;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAA;IAE5B;;OAEG;IACH,YAAY,IAAI,QAAQ,EAAE,CAAA;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA;IAE3D;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface-internal",
-  "version": "0.1.11-cf963694f",
+  "version": "0.1.11-e7167fe52",
   "description": "Interfaces implemented by internal libp2p components",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface-internal#readme",
@@ -63,8 +63,8 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "1.0.1-cf963694f",
-    "@libp2p/peer-collections": "4.0.10-cf963694f",
+    "@libp2p/interface": "1.0.1-e7167fe52",
+    "@libp2p/peer-collections": "4.0.10-e7167fe52",
     "@multiformats/multiaddr": "^12.1.10",
     "uint8arraylist": "^2.4.3"
   },

package/src/registrar/index.ts

@@ -1,7 +1,14 @@
 import type { Connection, Stream, Topology } from '@libp2p/interface'
 
 export interface IncomingStreamData {
+  /**
+   * The stream that has been opened
+   */
   stream: Stream
+
+  /**
+   * The connection that the stream was opened on
+   */
   connection: Connection
 }
 
@@ -29,7 +36,14 @@ export interface StreamHandlerOptions {
 }
 
 export interface StreamHandlerRecord {
+  /**
+   * The handler that was registered to handle streams opened on the protocol
+   */
   handler: StreamHandler
+
+  /**
+   * The options that were used to register the stream handler
+   */
   options: StreamHandlerOptions
 }
 

package/src/transport-manager/index.ts

@@ -2,13 +2,51 @@ import type { Connection, Listener, Transport } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
 export interface TransportManager {
+  /**
+   * Add a transport to the transport manager
+   */
   add(transport: Transport): void
+
+  /**
+   * Dial a multiaddr. Connections returned by this method will not be tracked
+   * by the connection manager so can cause memory leaks. If you need to dial
+   * a multiaddr, you may want to call openConnection on the connection manager
+   * instead.
+   */
   dial(ma: Multiaddr, options?: any): Promise<Connection>
+
+  /**
+   * Return all addresses currently being listened on
+   */
   getAddrs(): Multiaddr[]
+
+  /**
+   * Return all registered transports
+   */
   getTransports(): Transport[]
+
+  /**
+   * Return all listeners
+   */
   getListeners(): Listener[]
+
+  /**
+   * Get the transport for a given multiaddr, if one has been configured
+   */
   transportForMultiaddr(ma: Multiaddr): Transport | undefined
+
+  /**
+   * Listen on the passed multiaddrs
+   */
   listen(addrs: Multiaddr[]): Promise<void>
+
+  /**
+   * Remove a previously configured transport
+   */
   remove(key: string): Promise<void>
+
+  /**
+   * Remove all transports
+   */
   removeAll(): Promise<void>
 }