Skip to main content

Function: takeAsync()

Returns an async iterable containing the first count values of asyncIterable in iteration order.

If the count is greater than the number of values in asyncIterable, then an async iterable equivalent asyncIterable is returned.

Throws​

if count isn't a non-negative integer.

Example​

console.log(
  await pipe(
    asAsync([1, 2, 3, 4, 5, `sloth`]),
    takeAsync(3),
    reduceAsync(toArray()),
  ),
)
//=> [ 1, 2, 3 ]

takeAsync(count)​

takeAsync<Count>(count): <Value>(asyncIterable) => AsyncIterable<Value, any, any>

Returns an async iterable containing the first count values of asyncIterable in iteration order.

If the count is greater than the number of values in asyncIterable, then an async iterable equivalent asyncIterable is returned.

Type Parameters​

• Count extends number

Parameters​

• count: NonNegativeInteger<Count>

Returns​

Function

Type Parameters​

• Value

Parameters​

• asyncIterable: AsyncIterable<Value, any, any>

Returns​

AsyncIterable<Value, any, any>

Throws​

if count isn't a non-negative integer.

Example​

console.log(
  await pipe(
    asAsync([1, 2, 3, 4, 5, `sloth`]),
    takeAsync(3),
    reduceAsync(toArray()),
  ),
)
//=> [ 1, 2, 3 ]

Defined in​

splices.d.ts:290

takeAsync(count, asyncIterable)​

takeAsync<Count, Value>(count, asyncIterable): AsyncIterable<Value, any, any>

Returns an async iterable containing the first count values of asyncIterable in iteration order.

If the count is greater than the number of values in asyncIterable, then an async iterable equivalent asyncIterable is returned.

Type Parameters​

• Count extends number

• Value

Parameters​

• count: NonNegativeInteger<Count>

• asyncIterable: AsyncIterable<Value, any, any>

Returns​

AsyncIterable<Value, any, any>

Throws​

if count isn't a non-negative integer.

Example​

console.log(
  await pipe(
    asAsync([1, 2, 3, 4, 5, `sloth`]),
    takeAsync(3),
    reduceAsync(toArray()),
  ),
)
//=> [ 1, 2, 3 ]

Defined in​

splices.d.ts:290