Skip to main content

Variable: sliceConcur()

const sliceConcur: {<Start>(start): {<End>(End): <Value>(concurIterable) => ConcurIterable<Value>; <End, Value>(End, concurIterable): ConcurIterable<Value>; }; <Start, End>(start, End): <Value>(concurIterable) => ConcurIterable<Value>; <Start, End, Value>(start, End, concurIterable): ConcurIterable<Value>; }

Defined in: splices.d.ts:853

Returns a concur iterable containing the values of concurIterable between start and end (exclusive) of concurIterable in iteration order.

If any part of the range between start and end is outside the bounds of the concur iterable, then that part is excluded from the returned concur iterable. Thus, the returned concur iterable may be empty.

WARNING: This function linearly iterates up to end because concur iterables do not support random access.

Call Signature​

<Start>(start): {<End>(End): <Value>(concurIterable) => ConcurIterable<Value>; <End, Value>(End, concurIterable): ConcurIterable<Value>; }

Type Parameters​

Start​

Start extends number

Parameters​

start​

NonNegativeInteger<Start>

Returns​

<End>(End): <Value>(concurIterable) => ConcurIterable<Value>

Type Parameters​

End​

End extends number

Parameters​

End​

NonNegativeInteger<End>

Returns​

<Value>(concurIterable): ConcurIterable<Value>

Type Parameters​
Value​

Value

Parameters​
concurIterable​

ConcurIterable<Value>

Returns​

ConcurIterable<Value>

<End, Value>(End, concurIterable): ConcurIterable<Value>

Type Parameters​

End​

End extends number

Value​

Value

Parameters​

End​

NonNegativeInteger<End>

concurIterable​

ConcurIterable<Value>

Returns​

ConcurIterable<Value>

Call Signature​

<Start, End>(start, End): <Value>(concurIterable) => ConcurIterable<Value>

Type Parameters​

Start​

Start extends number

End​

End extends number

Parameters​

start​

NonNegativeInteger<Start>

End​

NonNegativeInteger<End>

Returns​

<Value>(concurIterable): ConcurIterable<Value>

Type Parameters​

Value​

Value

Parameters​

concurIterable​

ConcurIterable<Value>

Returns​

ConcurIterable<Value>

Call Signature​

<Start, End, Value>(start, End, concurIterable): ConcurIterable<Value>

Type Parameters​

Start​

Start extends number

End​

End extends number

Value​

Value

Parameters​

start​

NonNegativeInteger<Start>

End​

NonNegativeInteger<End>

concurIterable​

ConcurIterable<Value>

Returns​

ConcurIterable<Value>

Throws​

if either start or end is not a non-negative integer, or if start is greater than end.

Example​

const concurIterable = asConcur([`sloth`, `more sloth`, `even more sloth`])

console.log(
  await pipe(
    concurIterable,
    sliceConcur(0, 3),
    reduceConcur(toArray()),
  ),
)
//=> [ 'sloth', 'more sloth', 'even more sloth' ]

console.log(
  await pipe(
    concurIterable,
    sliceConcur(0, 42),
    reduceConcur(toArray()),
  ),
)
//=> [ 'sloth', 'more sloth', 'even more sloth' ]

console.log(
  await pipe(
    concurIterable,
    sliceConcur(1, 3),
    reduceConcur(toArray()),
  ),
)
//=> [ 'more sloth', 'even more sloth' ]

console.log(
  await pipe(
    concurIterable,
    sliceConcur(3, 5),
    reduceConcur(toArray()),
  ),
)
//=> []

Since​

v3.5.0