Iterators | plannerjs - v0.4.1

Utility class with functions to operate on AsyncIterator instances

Hierarchy

Iterators

Index

Methods

Methods

Static find

find<T>(iterator: AsyncIterator<T>, predicate: function): Promise<T>

- Defined in src/util/Iterators.ts:35
Iterates over elements of an AsyncIterator, returning the first element ´predicate´ returns truthy for.

Type parameters
- T
Parameters
- iterator: AsyncIterator<T>
- predicate: function
  - - (element: T): boolean
    - Parameters
      - element: T
      Returns boolean
Returns Promise<T>

Static getFirst

getFirst<T>(iterator: AsyncIterator<T>): Promise<T>

- Defined in src/util/Iterators.ts:24
Returns the first element of an AsyncIterator.

Type parameters
- T
Parameters
- iterator: AsyncIterator<T>
Returns Promise<T>

Static toArray

toArray<T>(iterator: AsyncIterator<T>): Promise<T[]>

- Defined in src/util/Iterators.ts:12
Returns an array representation of an AsyncIterator. Assumes the iterator will end sometime

Type parameters
- T
Parameters
- iterator: AsyncIterator<T>
Returns Promise<T[]>

Generated using TypeDoc