Class Stream<T>

Wrapper class to extend the functionality of an Iterable

Type Parameters

Hierarchy (View Summary)

AsyncStream<T>
- Stream

Implements

StreamLike<T>

Index

Constructors

constructor

Methods

[asyncIterator] [iterator] collect collectAsync pipe pipeAsync

Constructors

constructor

new Stream<T>(iterable?: Iterable<T, any, any> | null): Stream<T>
Type Parameters
- T
Parameters
- iterable: Iterable<T, any, any> | null = null
Returns Stream<T>
Overrides AsyncStream.constructor
- Defined in stream.ts:10

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T>
Returns AsyncIterator<T>
Implementation of StreamLike.[asyncIterator]
Overrides AsyncStream.[asyncIterator]
- Defined in stream.ts:20

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Implementation of StreamLike.[iterator]
- Defined in stream.ts:14

collect

collect<O>(collector: CollectorFunction<T, O>): O
Calls a collector function on the Iterable
Type Parameters
- O
Parameters
- collector: CollectorFunction<T, O>
Returns O
Implementation of StreamLike.collect
- Defined in stream.ts:26

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 StreamLike.collectAsync
Inherited from AsyncStream.collectAsync
- Defined in asyncStream.ts:22

pipe

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

Returns Stream<T>
Implementation of StreamLike.pipe
- Defined in stream.ts:32
pipe<A>(op1: OperationFunction<T, A>): Stream<A>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
Parameters
- op1: OperationFunction<T, A>
Returns Stream<A>
Implementation of StreamLike.pipe
- Defined in stream.ts:33
pipe<A, B>(
op1: OperationFunction<T, A>,
op2: OperationFunction<A, B>,
): Stream
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
Returns Stream
Implementation of StreamLike.pipe
- Defined in stream.ts:34
pipe<A, B, C>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
): Stream<C>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
Returns Stream<C>
Implementation of StreamLike.pipe
- Defined in stream.ts:38
pipe<A, B, C, D>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
): Stream<D>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
Returns Stream<D>
Implementation of StreamLike.pipe
- Defined in stream.ts:43
pipe<A, B, C, D, E>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
 op5: OperationFunction<D, E>,
): Stream<E>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
- E
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
- op5: OperationFunction<D, E>
Returns Stream<E>
Implementation of StreamLike.pipe
- Defined in stream.ts:49
pipe<A, B, C, D, E, F>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
 op5: OperationFunction<D, E>,
 op6: OperationFunction<E, F>,
): Stream<F>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
- op5: OperationFunction<D, E>
- op6: OperationFunction<E, F>
Returns Stream<F>
Implementation of StreamLike.pipe
- Defined in stream.ts:56
pipe<A, B, C, D, E, F, G>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
 op5: OperationFunction<D, E>,
 op6: OperationFunction<E, F>,
 op7: OperationFunction<F, G>,
): Stream<G>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
- op5: OperationFunction<D, E>
- op6: OperationFunction<E, F>
- op7: OperationFunction<F, G>
Returns Stream<G>
Implementation of StreamLike.pipe
- Defined in stream.ts:64
pipe<A, B, C, D, E, F, G, H>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
 op5: OperationFunction<D, E>,
 op6: OperationFunction<E, F>,
 op7: OperationFunction<F, G>,
 op8: OperationFunction<G, H>,
): Stream<H>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
- op5: OperationFunction<D, E>
- op6: OperationFunction<E, F>
- op7: OperationFunction<F, G>
- op8: OperationFunction<G, H>
Returns Stream<H>
Implementation of StreamLike.pipe
- Defined in stream.ts:73
pipe<A, B, C, D, E, F, G, H, I>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
 op5: OperationFunction<D, E>,
 op6: OperationFunction<E, F>,
 op7: OperationFunction<F, G>,
 op8: OperationFunction<G, H>,
 op9: OperationFunction<H, I>,
): Stream<H>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
- op5: OperationFunction<D, E>
- op6: OperationFunction<E, F>
- op7: OperationFunction<F, G>
- op8: OperationFunction<G, H>
- op9: OperationFunction<H, I>
Returns Stream<H>
Implementation of StreamLike.pipe
- Defined in stream.ts:83
pipe<A, B, C, D, E, F, G, H, I>(
 op1: OperationFunction<T, A>,
 op2: OperationFunction<A, B>,
 op3: OperationFunction<B, C>,
 op4: OperationFunction<C, D>,
 op5: OperationFunction<D, E>,
 op6: OperationFunction<E, F>,
 op7: OperationFunction<F, G>,
 op8: OperationFunction<G, H>,
 op9: OperationFunction<H, I>,
): Stream
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
- op5: OperationFunction<D, E>
- op6: OperationFunction<E, F>
- op7: OperationFunction<F, G>
- op8: OperationFunction<G, H>
- op9: OperationFunction<H, I>
Returns Stream
Implementation of StreamLike.pipe
- Defined in stream.ts:94
pipe(...ops: OperationFunction<T, T>[]): Stream<T>
Calls an operation function on the Iterable then returns the result as a Stream allowing to chain it with more Stream related methods.
Parameters
- ...ops: OperationFunction<T, T>[]
Returns Stream<T>
Implementation of StreamLike.pipe
- Defined in stream.ts:105

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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.pipeAsync
- Defined in asyncStream.ts:29
pipeAsync<A, B>(
op1: AsyncOperationFunction<T, A>,
op2: AsyncOperationFunction<A, B>,
): AsyncStream
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
Implementation of StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.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
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
Implementation of StreamLike.pipeAsync
Inherited from AsyncStream.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 StreamLike.pipeAsync
Inherited from AsyncStream.pipeAsync
- Defined in asyncStream.ts:101

Class Stream<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Stream<T>

Methods

[asyncIterator]

Returns AsyncIterator<T>

[iterator]

Returns Iterator<T>

collect

Type Parameters

Parameters

Returns O

collectAsync

Type Parameters

Parameters

Returns Promise<O>

pipe

Returns Stream<T>

Type Parameters

Parameters

Returns Stream<A>

Type Parameters

Parameters

Returns Stream<B>

Type Parameters

Parameters

Returns Stream<C>

Type Parameters

Parameters

Returns Stream<D>

Type Parameters

Parameters

Returns Stream<E>

Type Parameters

Parameters

Returns Stream<F>

Type Parameters

Parameters

Returns Stream<G>

Type Parameters

Parameters

Returns Stream<H>

Type Parameters

Parameters

Returns Stream<H>

Type Parameters

Parameters

Returns Stream<I>

Parameters

Returns Stream<T>

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