Interface ExtendedIterable<T>

An iterable with additional methods.

Type Parameters

Hierarchy

Iterable<T>
- ExtendedIterable

Index

Properties

async at concat consume every filter find first forEach getIterator isEmpty map pipe reduce scan slice some take toArray

Methods

[iterator]

Properties

async

async: (() => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

- (): ExtendedAsyncIterable<Awaited<T>>
- Maps the iterable to an equivalent async iterable.
 
 Returns
 An async iterable of the same type.
 
 Returns ExtendedAsyncIterable<Awaited<T>>

at

at: ((n: number) => undefined | T)

Type declaration

- (n: number): undefined | T
- Returns the nth element of the iterable.
  
  Returns
  The nth element of the iterable, or undefined if the iterable is shorter than n + 1 elements.
  Parameters
  - n: number
    
    The index of the element to return.
  Returns undefined | T

concat

concat: ((...iterables: (ExtendedIterable<T> | Iterable<T>)[]) => ExtendedIterable<T>)

Type declaration

- (...iterables: (ExtendedIterable<T> | Iterable<T>)[]): ExtendedIterable<T>
- Creates an iterable by concatenating an arbitrary number of iterables with the current iterable.
 
 Returns
 An iterable containing the elements of the current iterable followed by the elements of the provided iterables.
 Parameters
 - Rest ...iterables: (ExtendedIterable<T> | Iterable<T>)[]
 
 The iterables to concatenate.
 Returns ExtendedIterable<T>

consume

consume: ((mapFn?: MapFn<T, U>) => U[])

Type declaration

- (mapFn?: MapFn<T, U>): U[]
- Fully consumes the iterable while passing each value to the provided callback. The values returned from calling the callback function are returned as an array.
 
 Returns
 An array containing the values returned from calling the callback function.
 Type Parameters
 - U
 Parameters
 - Optional mapFn: MapFn<T, U>
 
 A callback function that receives the current value and index of the iterable.
 Returns U[]

every

every: ((predicate: ArrayLikePredicate<T>) => boolean)

Type declaration

- (predicate: ArrayLikePredicate<T>): boolean
- Tests whether all values of the iterable satisfy the provided predicate.
 
 Returns
 true if all values of the iterable satisfy the provided predicate, otherwise false.
 Parameters
 - predicate: ArrayLikePredicate<T>
 
 A predicate function that receives the current value and index of the iterable.
 Returns boolean

filter

filter: ((predicate: ArrayLikePredicate<T>) => ExtendedIterable<T>)

Type declaration

- (predicate: ArrayLikePredicate<T>): ExtendedIterable<T>
- Parameters
 - predicate: ArrayLikePredicate<T>
 Returns ExtendedIterable<T>

find

find: ((predicate: ArrayLikePredicate<T>) => undefined | T)

Type declaration

- (predicate: ArrayLikePredicate<T>): undefined | T
- Parameters
 - predicate: ArrayLikePredicate<T>
 Returns undefined | T

first

first: ((predicate?: ArrayLikePredicate<T>) => ExtendedIterable<T>)

Type declaration

- (predicate?: ArrayLikePredicate<T>): ExtendedIterable<T>
- Parameters
 - Optional predicate: ArrayLikePredicate<T>
 Returns ExtendedIterable<T>

forEach

forEach: ((fn: ((element: T, index: number) => void)) => ExtendedIterable<T>)

Type declaration

- (fn: ((element: T, index: number) => void)): ExtendedIterable<T>
- Parameters
 - fn: ((element: T, index: number) => void)
 - (element: T, index: number): void
 
 Parameters
 
 element: T
 
 index: number
 
 Returns void
 Returns ExtendedIterable<T>

getIterator

getIterator: (() => Iterator<T, any, undefined>)

Type declaration

- (): Iterator<T, any, undefined>
- Returns Iterator<T, any, undefined>

isEmpty

isEmpty: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

map

map: ((mapFn: MapFn<T, U>) => ExtendedIterable)

Type declaration

- (mapFn: MapFn<T, U>): ExtendedIterable
- Type Parameters
 - U
 Parameters
 - mapFn: MapFn<T, U>
 Returns ExtendedIterable

pipe

pipe: CookedPipe<ExtendedIterable<T>>

reduce

reduce: ((reducer: Reducer<T, U>, initialValue?: U) => U)

Type declaration

- (reducer: Reducer<T, U>, initialValue?: U): U
- Type Parameters
 - U = T
 Parameters
 - reducer: Reducer<T, U>
 - Optional initialValue: U
 Returns U

scan

scan: ((reducer: Reducer<T, U>, initialValue?: U) => ExtendedIterable)

Type declaration

- (reducer: Reducer<T, U>, initialValue?: U): ExtendedIterable
- Type Parameters
 - U = T
 Parameters
 - reducer: Reducer<T, U>
 - Optional initialValue: U
 Returns ExtendedIterable

slice

slice: ((startIndex: number, endIndex?: number) => ExtendedIterable<T>)

Type declaration

- (startIndex: number, endIndex?: number): ExtendedIterable<T>
- Parameters
 - startIndex: number
 - Optional endIndex: number
 Returns ExtendedIterable<T>

some

some: ((predicate: ArrayLikePredicate<T>) => boolean)

Type declaration

- (predicate: ArrayLikePredicate<T>): boolean
- Parameters
 - predicate: ArrayLikePredicate<T>
 Returns boolean

take

take: ((n: number) => ExtendedIterable<T>)

Type declaration

- (n: number): ExtendedIterable<T>
- Parameters
 - n: number
 Returns ExtendedIterable<T>

toArray

toArray: (() => T[])

Type declaration

- (): T[]
- Returns T[]

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Inherited from Iterable.__@iterator@85
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:51

Interface ExtendedIterable<T>

Type Parameters

T

Hierarchy

Index

Properties

Methods

Properties

async

Type declaration

Returns

Returns ExtendedAsyncIterable<Awaited<T>>

at

Type declaration

Returns

Parameters

n: number

Returns undefined | T

concat

Type declaration

Returns

Parameters

Rest ...iterables: (ExtendedIterable<T> | Iterable<T>)[]

Returns ExtendedIterable<T>

consume

Type declaration

Returns

Type Parameters

U

Parameters

Optional mapFn: MapFn<T, U>

Returns U[]

every

Type declaration

Returns

Parameters

predicate: ArrayLikePredicate<T>

Returns boolean

filter

Type declaration

Parameters

predicate: ArrayLikePredicate<T>

Returns ExtendedIterable<T>

find

Type declaration

Parameters

predicate: ArrayLikePredicate<T>

Returns undefined | T

first

Type declaration

Parameters

Optional predicate: ArrayLikePredicate<T>

Returns ExtendedIterable<T>

forEach

Type declaration

Parameters

fn: ((element: T, index: number) => void)

Parameters

element: T

index: number

Returns void

Returns ExtendedIterable<T>

getIterator

Type declaration

Returns Iterator<T, any, undefined>

isEmpty

Type declaration

Returns boolean

map

Type declaration

Type Parameters

U

Parameters

mapFn: MapFn<T, U>

Returns ExtendedIterable<U>

pipe

reduce

Type declaration

Type Parameters

U = T

`Rest` ...iterables: (ExtendedIterable<T> | Iterable<T>)[]

`Optional` mapFn: MapFn<T, U>

`Optional` predicate: ArrayLikePredicate<T>

`Optional` initialValue: U

`Optional` initialValue: U

`Optional` endIndex: number