Skip to main content

flatMap

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

This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned 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. May be async. May be a stream or generator.

Return Type Jump to heading

Readable

a stream flat-mapped with the function fn.

Back to top