Skip to main content

map

method ReadableBase.prototype.map
Jump to headingReadableBase.prototype.map(
fn: (
data: any,
options?: Pick<ArrayOptions, "signal">,
) => any,
options?: ArrayOptions,
): Readable

This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

Parameters Jump to heading

Jump to headingfn: (
data: any,
options?: Pick<ArrayOptions, "signal">,
) => any

a function to map over every chunk in the stream. Async or not.

Return Type Jump to heading

Readable

a stream mapped with the function fn.

Back to top