Skip to main content

asIndexedPairs

method ReadableBase.prototype.asIndexedPairs
Jump to headingReadableBase.prototype.asIndexedPairs(options?: Pick<ArrayOptions, "signal">): Readable

This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

Parameters Jump to heading

optional
Jump to headingoptions: Pick<ArrayOptions, "signal">

Return Type Jump to heading

Readable

a stream of indexed pairs.

Back to top