Skip to main content

every

method ReadableBase.prototype.every
Jump to headingReadableBase.prototype.every(
fn: (
data: any,
options?: Pick<ArrayOptions, "signal">,
) => boolean | Promise<boolean>,
options?: ArrayOptions,
): Promise<boolean>

This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

Parameters Jump to heading

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

a function to call on each chunk of the stream. Async or not.

Return Type Jump to heading

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for every one of the chunks.

Back to top