iterable

iterable

Source:

iterable/iterable.ts, line 6

Methods

(static) eachIterableF<T extends Iterable<any>>(callbackFn, iterable) → {T}

Source:

iterable/iterable.ts, line 53

Name	Type	Description
`callbackFn`	EachIterableCallbackType<T, void>
`iterable`	T

Returns:

Type: T

(static) filterIterableF<T extends Iterable<any>>(callbackFn, iterable) → {IterableIterator<CheckPromiseIterableType<T>>}

Source:

iterable/iterable.ts, line 77

Name	Type	Description
`callbackFn`	EachIterableCallbackType<T, boolean>
`iterable`	T

Returns:

Type: IterableIterator<CheckPromiseIterableType<T>>

(static) headIterable<T>(iterable) → {T}

Source:

iterable/iterable.ts, line 89

Name	Type	Description
`iterable`	Iterable<T>

Returns:

Type: T

(static) mapIterableF<T extends Iterable<any>, U>(callbackFn, iterable) → {Iterable<U | Promise<U>>}

Source:

iterable/iterable.ts, line 67

Name	Type	Description
`callbackFn`	EachIterableCallbackType<T, U>
`iterable`	T

mapIterableF<T extends Iterable<any>, U>(callbackFn, iterable) → {CheckPromiseType<CheckIterableType<T>, Iterable<U | Promise<U>>, Iterable<U>>}

Name	Type	Description
`callbackFn`	EachIterableCallbackType<T, U>
`iterable`	T

Returns:

Type: Iterable<U | Promise<U>>

(static) reduceIterableF<T, U extends Iterable<any>>(callbackFn, initial, iterable) → {Promise<T> | T}

Source:

iterable/iterable.ts, line 38

Name	Type	Description
`callbackFn`	ReduceIterableCallbackType<T, CheckPromiseIterableType<U>, U>
`initial`	T
`iterable`	U

reduceIterableF<T, U extends Iterable<any>>(callbackFn, initial, iterable) → {IterableReturnType<U, T>}

Name	Type	Description
`callbackFn`	ReduceIterableCallbackType<T, CheckPromiseIterableType<U>, U>
`initial`	T
`iterable`	U

Returns:

Type: Promise<T> | T

(static) tailIterable<T>(iterable) → {T}

Source:

iterable/iterable.ts, line 98

Name	Type	Description
`iterable`	Iterable<T>

Returns:

Type: T

(static) takeIterableF<T>(length, iterable) → {PromiseReturnType<Array<PureType<T>>>}

Source:

iterable/iterable.ts, line 111

Name	Type	Description
`length`	number
`iterable`	AsyncIterableType<T>

Returns:

Type: PromiseReturnType<Array<PureType<T>>>

Type Definitions

EachIterableCallbackType<T extends Iterable<any>, U>

Source:

iterable/iterable.ts, line 20

Type:

(value: CheckPromiseIterableType<T>, iterable: T) => U

IterableReturnType<T extends Iterable<any>, U>

Source:

iterable/iterable.ts, line 13

Type:

CheckPromiseReturnType<CheckIterableType<T>, U>

ReduceIterableCallbackType<T, U, R extends Iterable<U | Promise<U>> = Iterable<U>>

Source:

iterable/iterable.ts, line 27

Type:

(previousValue: T, currentValue: U, iterable: R) => T