Skip to main content

Function: take()

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

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

Throws​

if count isn't a non-negative integer.

Example​

console.log(
  pipe(
    [1, 2, 3, 4, 5, `sloth`],
    take(3),
    reduce(toArray()),
  ),
)
//=> [ 1, 2, 3 ]

Since​

v0.0.1

Call Signature​

take<Count>(count): <Value>(iterable) => Iterable<Value, any, any>

Type Parameters​

• Count extends number

Parameters​

count​

NonNegativeInteger<Count>

Returns​

Function

Type Parameters​

• Value

Parameters​

iterable​

Iterable<Value, any, any>

Returns​

Iterable<Value, any, any>

Defined in​

splices.d.ts:275

Call Signature​

take<Count, Value>(count, iterable): Iterable<Value, any, any>

Type Parameters​

• Count extends number

• Value

Parameters​

count​

NonNegativeInteger<Count>

iterable​

Iterable<Value, any, any>

Returns​

Iterable<Value, any, any>

Defined in​

splices.d.ts:275