ldiamond/strom
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Jerry Kurian 2020-04-27 14:28:55 -04:00
parent 5dd856deed
commit 46d118d4a5
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/functions/index.ts
View File

@ -256,11 +256,14 @@ export default function mhysa(defaultOptions?: TransformOptions) {
/** /**
* Composes multiple streams together. Writing occurs on first stream, piping occurs from last stream. * Composes multiple streams together. Writing occurs on first stream, piping occurs from last stream.
* @param construct Constructor for new output source. Should return a Writable or ReadWrite stream. * @param {Function} construct Constructor for new output source. Should return a Writable or ReadWrite stream.
* @param demuxBy * @param {String | Function} demuxBy
* @param demuxBy.key? Key to fetch value from source chunks to demultiplex source. * @param {string} demuxBy.key? Key to fetch value from source chunks to demultiplex source.
* @param demuxBy.keyBy? Function to fetch value from source chunks to demultiplex source. * @param {Function} demuxBy.keyBy? Function to fetch value from source chunks to demultiplex source.
* @param options Writable stream options * @param {Object} options Demux stream options
* @param {boolean} options.remultiplex? If demux should be remultiplexed into a single destination
* @param {number} options.purgeIdleInterval? Interval at which a purge for idle pipelines will occur
* @param {number} options.maxIdleTime? Min time a demuxed pipeline must be idle for to be purged
*/ */
demux: withDefaultOptions(2, demux), demux: withDefaultOptions(2, demux),
}; };