Skip to main content

some

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

This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

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 at least one of the chunks.

Back to top