Class Iterator<T>

Type Parameters

T

Implements

AsyncIterableIterator<T>

Index

Constructors

Methods

[asyncIterator] fold forEach map next

Constructors

constructor

new Iterator<T>(iter): Iterator<T>
Type Parameters
- T
Parameters
- iter: AsyncIterableIterator<T, any, any>
Returns Iterator<T>
- Defined in index.ts:308

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<T, any, any>
Returns AsyncIterableIterator<T, any, any>
Implementation of AsyncIterableIterator.[asyncIterator]
- Defined in index.ts:310

fold

fold<B>(acc, fn): Promise<B>
Calls a defined callback function on each QueryResult. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
- B
Parameters
- acc: B
  The initial value of the accumulator.
- fn: ((value: T, acc: B) => B)
  A function that accepts a QueryResult and accumulator, and returns an accumulator.
  - - (value, acc): B
    - Parameters
      value: T
      acc: B
      Returns B
Returns Promise<B>
- Defined in index.ts:354

forEach

forEach(fn): Promise<void>
Performs the specified action for each element.
Parameters
- fn: ((value: T) => void)
  A function that accepts a QueryResult. forEach calls the fn function one time for each QueryResult.
  - - (value): void
    - Parameters
      value: T
      Returns void
Returns Promise<void>
- Defined in index.ts:342

map

map<B>(fn): Iterator<B>
Calls a defined callback function on each QueryResult, and returns an array that contains the results.
Type Parameters
- B
Parameters
- fn: ((t: T) => B)
  A function that accepts a QueryResult. map calls the fn function one time for each QueryResult.
  - - (t): B
    - Parameters
      t: T
      Returns B
Returns Iterator<B>
- Defined in index.ts:322

next

next(): Promise<IteratorResult<T, any>>
Returns Promise<IteratorResult<T, any>>
Implementation of AsyncIterableIterator.next
- Defined in index.ts:314