1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 20:39:08 +01:00
metamask-extension/app/scripts/lib/stream-utils.js
Mark Stacey 14d85b1332
Make JSDoc formatting more consistent (#9796)
A few inconsistencies in JSDoc formatting have been fixed throughout
the project. Many issues remain; these were just the few things that
were easy to fix with a regular expression.

The changes include:

* Using lower-case for primitive types, but capitalizing non-primitive
 types
* Separating the parameter identifier and the description with a dash
* Omitting a dash between the return type and the return description
* Ensuring the parameter type is first and the identifier is second (in
 a few places it was backwards)
* Using square brackets to denote when a parameter is optional, rather
 than putting "(optional)" in the parameter description
* Including a type and identifier with every parameter
* Fixing inconsistent spacing, except where it's used for alignment
* Remove incorrectly formatted `@deprecated` tags that reference non-
 existent properties
* Remove lone comment block without accompanying function

Additionally, one parameter was renamed for clarity.
2020-11-10 14:00:41 -03:30

18 lines
445 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
}