1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-30 16:18:07 +01:00
metamask-extension/app/scripts/lib/stream-utils.js
Mark Stacey ac01c5c89a
Consistent jsdoc syntax (#7755)
* Specify type before parameter name

Various JSDoc `@param` entries were specified as `name {type}` rather
than `{type} name`.

A couple of `@return` entries have been given types as well.

* Use JSDoc optional syntax rather than Closure syntax

* Use @returns rather than @return

* Use consistent built-in type capitalization

Primitive types are lower-case, and Object is upper-case.

* Separate param/return description with a dash
2020-01-13 14:36:36 -04:00

23 lines
476 B
JavaScript

import ObjectMultiplex from 'obj-multiplex'
import pump from 'pump'
/**
* Sets up stream multiplexing for the given stream
* @param {any} connectionStream - the stream to mux
* @returns {stream.Stream} - the multiplexed stream
*/
export function setupMultiplex (connectionStream) {
const mux = new ObjectMultiplex()
pump(
connectionStream,
mux,
connectionStream,
(err) => {
if (err) {
console.error(err)
}
}
)
return mux
}