Stream | @szilanor/stream

Wrapper class to extend the functionality of an Iterable

Type Parameters

Hierarchy

Stream

Implements

Iterable<T>

Index

Constructors

constructor

Methods

Constructors

constructor

new Stream<T>(iterable: Iterable<T>): Stream<T>

- Defined in stream.ts:6
Type Parameters
- T
Parameters
- iterable: Iterable<T>
Returns Stream<T>

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>

Implementation of Iterable.__@iterator@81
- Defined in stream.ts:14
Returns the Iterator of the wrapped Iterable

Returns Iterator<T, any, undefined>

collect

collect<O>(collector: CollectorFunction<T, O>): O

- Defined in stream.ts:9
Calls a collector function on the Iterable

Type Parameters
- O
Parameters
- collector: CollectorFunction<T, O>
Returns O

pipe

pipe(): Stream<T>
pipe<A>(op1: OperationFunction<T, A>): Stream<A>
pipe<A, B>(op1: OperationFunction<T, A>, op2: OperationFunction<A, B>): Stream<B>
pipe<A, B, C>(op1: OperationFunction<T, A>, op2: OperationFunction<A, B>, op3: OperationFunction<B, C>): Stream<C>
pipe<A, B, C, D>(op1: OperationFunction<T, A>, op2: OperationFunction<A, B>, op3: OperationFunction<B, C>, op4: OperationFunction<C, D>): Stream<D>
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>
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>
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>
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>
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>
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>, ...ops: OperationFunction<any, any>[]): Stream<unknown>

- Defined in stream.ts:20
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>
- Defined in stream.ts:21
Type Parameters
- A
Parameters
- op1: OperationFunction<T, A>
Returns Stream<A>
- Defined in stream.ts:22
Type Parameters
- A
- B
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
Returns Stream<B>
- Defined in stream.ts:26
Type Parameters
- A
- B
- C
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
Returns Stream<C>
- Defined in stream.ts:31
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>
- Defined in stream.ts:37
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>
- Defined in stream.ts:44
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>
- Defined in stream.ts:52
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>
- Defined in stream.ts:61
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>
- Defined in stream.ts:71
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>
- Defined in stream.ts:82
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>
- Rest ...ops: OperationFunction<any, any>[]
Returns Stream<unknown>

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

T

Parameters

iterable: Iterable<T>

Returns Stream<T>

Methods

[iterator]

Returns Iterator<T, any, undefined>

collect

Type Parameters

O

Parameters

collector: CollectorFunction<T, O>

Returns O

pipe

Returns Stream<T>

Type Parameters

A

Parameters

op1: OperationFunction<T, A>

Returns Stream<A>

Type Parameters

A

B

Parameters

op1: OperationFunction<T, A>

op2: OperationFunction<A, B>

Returns Stream<B>

Type Parameters

A

B

C

Parameters

op1: OperationFunction<T, A>

op2: OperationFunction<A, B>

op3: OperationFunction<B, C>

Returns Stream<C>

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>

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>

Type Parameters

A

B

C

D

E

F

Parameters

op1: OperationFunction<T, A>

op2: OperationFunction<A, B>