Class AsyncStream<T>

Wrapper class to extend the functionality of an AsyncIterable

Type Parameters

Hierarchy (View Summary)

AsyncStream
- Stream

Implements

AsyncStreamLike<T>

Index

Constructors

constructor

Methods

[asyncIterator] collectAsync pipeAsync

Constructors

constructor

new AsyncStream<T>(
asyncIterable?: AsyncIterable<T, any, any> | null,
): AsyncStream<T>
Type Parameters
- T
Parameters
- asyncIterable: AsyncIterable<T, any, any> | null = null
Returns AsyncStream<T>
- Defined in asyncStream.ts:19

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T>
Returns AsyncIterator<T>
Implementation of AsyncStreamLike.[asyncIterator]
- Defined in asyncStream.ts:13

collectAsync

collectAsync<O>(collector: AsyncCollectorFunction<T, O>): Promise<O>
Calls a collector function on the AsyncIterable
Type Parameters
- O
Parameters
- collector: AsyncCollectorFunction<T, O>
Returns Promise<O>
Implementation of AsyncStreamLike.collectAsync
- Defined in asyncStream.ts:22

pipeAsync

pipeAsync(): AsyncStream<T>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.

Returns AsyncStream<T>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:28
pipeAsync<A>(op1: AsyncOperationFunction<T, A>): AsyncStream<A>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
Parameters
- op1: AsyncOperationFunction<T, A>
Returns AsyncStream<A>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:29
pipeAsync<A, B>(
op1: AsyncOperationFunction<T, A>,
op2: AsyncOperationFunction<A, B>,
): AsyncStream<B>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
Returns AsyncStream<B>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:30
pipeAsync<A, B, C>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
): AsyncStream<C>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
Returns AsyncStream<C>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:34
pipeAsync<A, B, C, D>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
): AsyncStream<D>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
Returns AsyncStream<D>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:39
pipeAsync<A, B, C, D, E>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
    op5: AsyncOperationFunction<D, E>,
): AsyncStream<E>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
- E
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
- op5: AsyncOperationFunction<D, E>
Returns AsyncStream<E>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:45
pipeAsync<A, B, C, D, E, F>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
    op5: AsyncOperationFunction<D, E>,
    op6: AsyncOperationFunction<E, F>,
): AsyncStream<F>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
- op5: AsyncOperationFunction<D, E>
- op6: AsyncOperationFunction<E, F>
Returns AsyncStream<F>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:52
pipeAsync<A, B, C, D, E, F, G>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
    op5: AsyncOperationFunction<D, E>,
    op6: AsyncOperationFunction<E, F>,
    op7: AsyncOperationFunction<F, G>,
): AsyncStream<G>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
- op5: AsyncOperationFunction<D, E>
- op6: AsyncOperationFunction<E, F>
- op7: AsyncOperationFunction<F, G>
Returns AsyncStream<G>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:60
pipeAsync<A, B, C, D, E, F, G, H>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
    op5: AsyncOperationFunction<D, E>,
    op6: AsyncOperationFunction<E, F>,
    op7: AsyncOperationFunction<F, G>,
    op8: AsyncOperationFunction<G, H>,
): AsyncStream<H>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
- op5: AsyncOperationFunction<D, E>
- op6: AsyncOperationFunction<E, F>
- op7: AsyncOperationFunction<F, G>
- op8: AsyncOperationFunction<G, H>
Returns AsyncStream<H>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:69
pipeAsync<A, B, C, D, E, F, G, H, I>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
    op5: AsyncOperationFunction<D, E>,
    op6: AsyncOperationFunction<E, F>,
    op7: AsyncOperationFunction<F, G>,
    op8: AsyncOperationFunction<G, H>,
    op9: AsyncOperationFunction<H, I>,
): AsyncStream<H>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
- op5: AsyncOperationFunction<D, E>
- op6: AsyncOperationFunction<E, F>
- op7: AsyncOperationFunction<F, G>
- op8: AsyncOperationFunction<G, H>
- op9: AsyncOperationFunction<H, I>
Returns AsyncStream<H>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:79
pipeAsync<A, B, C, D, E, F, G, H, I>(
    op1: AsyncOperationFunction<T, A>,
    op2: AsyncOperationFunction<A, B>,
    op3: AsyncOperationFunction<B, C>,
    op4: AsyncOperationFunction<C, D>,
    op5: AsyncOperationFunction<D, E>,
    op6: AsyncOperationFunction<E, F>,
    op7: AsyncOperationFunction<F, G>,
    op8: AsyncOperationFunction<G, H>,
    op9: AsyncOperationFunction<H, I>,
): AsyncStream<I>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: AsyncOperationFunction<T, A>
- op2: AsyncOperationFunction<A, B>
- op3: AsyncOperationFunction<B, C>
- op4: AsyncOperationFunction<C, D>
- op5: AsyncOperationFunction<D, E>
- op6: AsyncOperationFunction<E, F>
- op7: AsyncOperationFunction<F, G>
- op8: AsyncOperationFunction<G, H>
- op9: AsyncOperationFunction<H, I>
Returns AsyncStream<I>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:90
pipeAsync(...ops: AsyncOperationFunction<T, T>[]): AsyncStream<T>
Calls an operation function on the AsyncIterable then returns the result as a AsyncStream allowing to chain it with more AsyncStream related methods.
Parameters
- ...ops: AsyncOperationFunction<T, T>[]
Returns AsyncStream<T>
Implementation of AsyncStreamLike.pipeAsync
- Defined in asyncStream.ts:101

Class AsyncStream<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AsyncStream<T>

Methods

[asyncIterator]

Returns AsyncIterator<T>

collectAsync

Type Parameters

Parameters

Returns Promise<O>

pipeAsync

Returns AsyncStream<T>

Type Parameters

Parameters

Returns AsyncStream<A>

Type Parameters

Parameters

Returns AsyncStream<B>

Type Parameters

Parameters

Returns AsyncStream<C>

Type Parameters

Parameters

Returns AsyncStream<D>

Type Parameters

Parameters

Returns AsyncStream<E>

Type Parameters

Parameters

Returns AsyncStream<F>

Type Parameters

Parameters

Returns AsyncStream<G>

Type Parameters

Parameters

Returns AsyncStream<H>

Type Parameters

Parameters

Returns AsyncStream<H>

Type Parameters

Parameters

Returns AsyncStream<I>

Parameters

Returns AsyncStream<T>

Settings

On This Page