diff --git a/src/functions/index.ts b/src/functions/index.ts index de61d44..db25fb8 100644 --- a/src/functions/index.ts +++ b/src/functions/index.ts @@ -256,11 +256,14 @@ export default function mhysa(defaultOptions?: TransformOptions) { /** * 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 demuxBy - * @param 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 options Writable stream options + * @param {Function} construct Constructor for new output source. Should return a Writable or ReadWrite stream. + * @param {String | Function} demuxBy + * @param {string} demuxBy.key? Key to fetch value from source chunks to demultiplex source. + * @param {Function} demuxBy.keyBy? Function to fetch value from source chunks to demultiplex source. + * @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), };