fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-04-24 17:52:21 +00:00
Code Issues Projects Releases Wiki Activity

chore: make metadata optional on addStream

Browse Source
This commit is contained in:
Vasco Santos 2020-12-10 12:32:34 +01:00
parent a99b9582dc
commit a24fafd570
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/connection/connection.js
View File

@ -33,6 +33,10 @@ const connectionSymbol = Symbol.for('@libp2p/interface-connection/connection')
* @property {() => Promise<void>} close - close raw connection function. * @property {() => Promise<void>} close - close raw connection function.
* @property {() => MuxedStream[]} getStreams - get streams from muxer function. * @property {() => MuxedStream[]} getStreams - get streams from muxer function.
* @property {ConectionStat} stat - metadata of the connection. * @property {ConectionStat} stat - metadata of the connection.
*
* @typedef {Object} StreamData
* @property {string} protocol - the protocol used by the stream
* @property {Object} [metadata] - metadata of the stream
*/ */
/** /**
@ -180,9 +184,7 @@ class Connection {
* Add a stream when it is opened to the registry. * Add a stream when it is opened to the registry.
* *
* @param {MuxedStream} muxedStream - a muxed stream * @param {MuxedStream} muxedStream - a muxed stream
* @param {object} properties - the stream properties to be registered * @param {StreamData} data - the stream data to be registered
* @param {string} properties.protocol - the protocol used by the stream
* @param {object} [properties.metadata] - metadata of the stream
* @returns {void} * @returns {void}
*/ */
addStream (muxedStream, { protocol, metadata = {} }) { addStream (muxedStream, { protocol, metadata = {} }) {