@szilanor/stream

Type Aliases

CollectorFunction

CollectorFunction<TInput, TOutput>: ((stream: Iterable<TInput>) => TOutput)

Type Parameters

TInput
TOutput

Type declaration

- (stream: Iterable<TInput>): TOutput
- Parameters
  - stream: Iterable<TInput>
  Returns TOutput

OperationFunction

OperationFunction<TInput, TOutput>: ((entries: Iterable<TInput>) => Iterable<TOutput>)

Type Parameters

TInput
TOutput

Type declaration

- (entries: Iterable<TInput>): Iterable<TOutput>
- Parameters
  - entries: Iterable<TInput>
  Returns Iterable<TOutput>

Functions

all

all<T>(predicate: ((item: T, index: number) => boolean)): CollectorFunction<T, boolean>

- Defined in collectors/all/all.ts:4
Returns true if all entries satisfy the 'predicate' function.

Type Parameters
- T
Parameters
- predicate: ((item: T, index: number) => boolean)
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns CollectorFunction<T, boolean>

any

any<T>(predicate?: ((item: T, index: number) => boolean)): CollectorFunction<T, boolean>

- Defined in collectors/any/any.ts:4
Returns true if at least one of the entries satisfies the 'predicate' function.

Type Parameters
- T
Parameters
- predicate: ((item: T, index: number) => boolean) = ...
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns CollectorFunction<T, boolean>

appendWith

appendWith<T>(...iterables: Iterable<T>[]): OperationFunction<T, T>

- Defined in operations/appendWith/appendWith.ts:5
Concatenates the Iterable with other Iterables in order

Type Parameters
- T
Parameters
- Rest ...iterables: Iterable<T>[]
Returns OperationFunction<T, T>

arrayFilter

arrayFilter<T>(func: ((entry: T, index: number, array: T[]) => boolean)): OperationFunction<T[], T[]>

- Defined in operations/arrayFilter/arrayFilter.ts:4
Returns an Iterable that yields only array entries of the source Iterable that satisfy the function.

Type Parameters
- T
Parameters
- func: ((entry: T, index: number, array: T[]) => boolean)
  - - (entry: T, index: number, array: T[]): boolean
    - Parameters
      - entry: T
      - index: number
      - array: T[]
      Returns boolean
Returns OperationFunction<T[], T[]>

arrayMap

arrayMap<T, O>(func: ((entry: T, index: number, array: T[]) => O)): OperationFunction<T[], O[]>

- Defined in operations/arrayMap/arrayMap.ts:4
Returns an Iterable that yields array entries of the source Iterable transformed using the function

Type Parameters
- T
- O
Parameters
- func: ((entry: T, index: number, array: T[]) => O)
  - - (entry: T, index: number, array: T[]): O
    - Parameters
      - entry: T
      - index: number
      - array: T[]
      Returns O
Returns OperationFunction<T[], O[]>

buffer

buffer<T>(size: number): OperationFunction<T, T[]>

- Defined in operations/buffer/buffer.ts:36
Returns an Iterable that yields array of entries of the source Iterable with the given length.

Type Parameters
- T
Parameters
- size: number
Returns OperationFunction<T, T[]>

compound

compound<T>(): OperationFunction<T, T>
compound<T, A>(op1: OperationFunction<T, A>): OperationFunction<T, A>
compound<T, A, B>(op1: OperationFunction<T, A>, op2: OperationFunction<A, B>): OperationFunction<T, B>
compound<T, A, B, C>(op1: OperationFunction<T, A>, op2: OperationFunction<A, B>, op3: OperationFunction<B, C>): OperationFunction<T, C>
compound<T, A, B, C, D>(op1: OperationFunction<T, A>, op2: OperationFunction<A, B>, op3: OperationFunction<B, C>, op4: OperationFunction<C, D>): OperationFunction<T, D>
compound<T, 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>): OperationFunction<T, E>
compound<T, 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>): OperationFunction<T, F>
compound<T, 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>): OperationFunction<T, G>
compound<T, 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>): OperationFunction<T, H>
compound<T, 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>): OperationFunction<T, I>
compound<T, A, B, C, D, E, F, G, H, I, J>(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>, op10: OperationFunction<I, J>, ...ops: OperationFunction<any, any>[]): OperationFunction<T, unknown>

- Defined in operations/compound/compound.ts:6
Type-safe helper operation that concatenates multiple operations in order.

Type Parameters
- T
Returns OperationFunction<T, T>
- Defined in operations/compound/compound.ts:7
Type Parameters
- T
- A
Parameters
- op1: OperationFunction<T, A>
Returns OperationFunction<T, A>
- Defined in operations/compound/compound.ts:10
Type Parameters
- T
- A
- B
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
Returns OperationFunction<T, B>
- Defined in operations/compound/compound.ts:14
Type Parameters
- T
- A
- B
- C
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
Returns OperationFunction<T, C>
- Defined in operations/compound/compound.ts:19
Type Parameters
- T
- A
- B
- C
- D
Parameters
- op1: OperationFunction<T, A>
- op2: OperationFunction<A, B>
- op3: OperationFunction<B, C>
- op4: OperationFunction<C, D>
Returns OperationFunction<T, D>
- Defined in operations/compound/compound.ts:25
Type Parameters
- T
- 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 OperationFunction<T, E>
- Defined in operations/compound/compound.ts:32
Type Parameters
- T
- 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 OperationFunction<T, F>
- Defined in operations/compound/compound.ts:40
Type Parameters
- T
- 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 OperationFunction<T, G>
- Defined in operations/compound/compound.ts:49
Type Parameters
- T
- 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 OperationFunction<T, H>
- Defined in operations/compound/compound.ts:59
Type Parameters
- T
- 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 OperationFunction<T, I>
- Defined in operations/compound/compound.ts:70
Type Parameters
- T
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
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>
- op10: OperationFunction<I, J>
- Rest ...ops: OperationFunction<any, any>[]
Returns OperationFunction<T, unknown>

concat

concat<T>(...iterables: Iterable<T>[]): Stream<T>

- Defined in creators/concat/concat.ts:29
Returns a Stream that yields elements of all Iterable parameters in order.

Type Parameters
- T
Parameters
- Rest ...iterables: Iterable<T>[]
Returns Stream<T>

concatWith

concatWith<T>(...iterables: Iterable<T>[]): OperationFunction<T, T>

- Defined in operations/concatWith/concatWith.ts:5
Concatenates the Iterable with other Iterables in order

Type Parameters
- T
Parameters
- Rest ...iterables: Iterable<T>[]
Returns OperationFunction<T, T>

contains

contains<T>(value: T, compareFunction?: ((a: T, b: T) => boolean)): CollectorFunction<T, boolean>

- Defined in collectors/contains/contains.ts:4
Returns if at least one of the entries equals with the given 'value'.

Type Parameters
- T
Parameters
- value: T
- compareFunction: ((a: T, b: T) => boolean) = ...
  - - (a: T, b: T): boolean
    - Parameters
      - a: T
      - b: T
      Returns boolean
Returns CollectorFunction<T, boolean>

count

count<T>(): CollectorFunction<T, number>

- Defined in collectors/count/count.ts:4
Returns the number of entries in the Iterable.

Type Parameters
- T
Returns CollectorFunction<T, number>

defaultIfEmpty

defaultIfEmpty<T>(value: T): OperationFunction<T, T>

- Defined in operations/defaultIfEmpty/defaultIfEmpty.ts:4
Returns an Iterable with the value parameter if the source Iterable is empty.

Type Parameters
- T
Parameters
- value: T
Returns OperationFunction<T, T>

distinct

distinct<T>(): OperationFunction<T, T>

- Defined in operations/distinct/distinct.ts:29
Returns an Iterable that yields only entries of the source Iterable without duplicates.

Type Parameters
- T
Returns OperationFunction<T, T>

elementAt

elementAt<T>(index: number): CollectorFunction<T, T | undefined>

- Defined in collectors/elementAt/elementAt.ts:4
Returns the nth entry from the Iterable.

Type Parameters
- T
Parameters
- index: number
Returns CollectorFunction<T, T | undefined>

empty

empty<T>(): Stream<T>

- Defined in creators/empty/empty.ts:16
Type Parameters
- T
Returns Stream<T>

endWith

endWith<T>(...values: T[]): OperationFunction<T, T>

- Defined in operations/endWith/endWith.ts:5
Returns an Iterable with the entries of the source Iterable then the parameter value.

Type Parameters
- T
Parameters
- Rest ...values: T[]
Returns OperationFunction<T, T>

every

every<T>(predicate: ((item: T, index: number) => boolean)): CollectorFunction<T, boolean>

- Defined in collectors/all/all.ts:18
Type Parameters
- T
Parameters
- predicate: ((item: T, index: number) => boolean)
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns CollectorFunction<T, boolean>

falsy

falsy<T>(): OperationFunction<T, T>

- Defined in operations/falsy/falsy.ts:5
Returns an Iterable that yields only entries of the source Iterable with falsy value.

Type Parameters
- T
Returns OperationFunction<T, T>

filter

filter<T>(func: ((value: T, index: number) => boolean)): OperationFunction<T, T>

- Defined in operations/filter/filter.ts:30
Returns an Iterable that yields only entries of the source Iterable that satisfy the function.

Type Parameters
- T
Parameters
- func: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      - value: T
      - index: number
      Returns boolean
Returns OperationFunction<T, T>

find

find<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, T | undefined>

- Defined in collectors/first/first.ts:17
Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T | undefined>

findIndex

findIndex<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, number>

- Defined in collectors/firstIndex/firstIndex.ts:19
Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, number>

findLast

findLast<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, T | undefined>

- Defined in collectors/last/last.ts:18
Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T | undefined>

findLastIndex

findLastIndex<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, number>

- Defined in collectors/lastIndex/lastIndex.ts:20
Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, number>

findLastOrDefault

findLastOrDefault<T>(defaultValue: T, predicate?: ((item: T) => boolean)): CollectorFunction<T, T | undefined>

- Defined in collectors/lastOrDefault/lastOrDefault.ts:19
Type Parameters
- T
Parameters
- defaultValue: T
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T | undefined>

findOrDefault

findOrDefault<T>(defaultValue: T, predicate?: ((item: T) => boolean)): CollectorFunction<T, T>

- Defined in collectors/firstOrDefault/firstOrDefault.ts:18
Type Parameters
- T
Parameters
- defaultValue: T
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T>

first

first<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, T | undefined>

- Defined in collectors/first/first.ts:4
Returns the first entry from the Iterable that satisfy then 'predicate' function.

Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T | undefined>

firstIndex

firstIndex<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, number>

- Defined in collectors/firstIndex/firstIndex.ts:4
Returns the index of the first entry from the Iterable that satisfy then 'predicate' function.

Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, number>

firstOrDefault

firstOrDefault<T>(defaultValue: T, predicate?: ((item: T) => boolean)): CollectorFunction<T, T>

- Defined in collectors/firstOrDefault/firstOrDefault.ts:4
Returns the first entry from the Iterable that satisfy then 'predicate' function or the 'defaultValue'.

Type Parameters
- T
Parameters
- defaultValue: T
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T>

flat

flat<T>(): OperationFunction<T[], T>

- Defined in operations/flat/flat.ts:4
Returns an Iterable that yields the inner entries of array entries of the source Iterable.

Type Parameters
- T
Returns OperationFunction<T[], T>

flatMap

flatMap<T, O>(func: ((value: T, index: number) => Iterable<O>)): OperationFunction<T, O>

- Defined in operations/flatMap/flatMap.ts:7
Returns an Iterable that yields the inner entries of the result produced by the function.

Type Parameters
- T
- O
Parameters
- func: ((value: T, index: number) => Iterable<O>)
  - - (value: T, index: number): Iterable<O>
    - Parameters
      - value: T
      - index: number
      Returns Iterable<O>
Returns OperationFunction<T, O>

flatten

flatten<T>(): OperationFunction<T[], T>

- Defined in operations/flat/flat.ts:15
Type Parameters
- T
Returns OperationFunction<T[], T>

forEach

forEach<T>(forEachFunction: ((item: T) => void)): CollectorFunction<T, void>

- Defined in collectors/forEach/forEach.ts:4
Call a callback function on every entry.

Type Parameters
- T
Parameters
- forEachFunction: ((item: T) => void)
  - - (item: T): void
    - Parameters
      - item: T
      Returns void
Returns CollectorFunction<T, void>

from

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

- Defined in creators/from/from.ts:6
Creates a Stream from an iterable (Array, Set, Map, Stream...)

Type Parameters
- T
Parameters
- iterable: Iterable<T>
Returns Stream<T>

group

group<T, TKey>(keySelector: ((entry: T) => TKey)): CollectorFunction<T, Record<TKey, T[]>>

- Defined in collectors/groupByRecord/groupByRecord.ts:22
Type Parameters
- T
- TKey extends string | number | symbol
Parameters
- keySelector: ((entry: T) => TKey)
  - - (entry: T): TKey
    - Parameters
      - entry: T
      Returns TKey
Returns CollectorFunction<T, Record<TKey, T[]>>

groupBy

groupBy<T, TKey>(keySelector: ((entry: T) => TKey)): CollectorFunction<T, Map<TKey, T[]>>

- Defined in collectors/groupBy/groupBy.ts:4
Creates a group of entries where the group key is calculated by the selector function.

Type Parameters
- T
- TKey
Parameters
- keySelector: ((entry: T) => TKey)
  - - (entry: T): TKey
    - Parameters
      - entry: T
      Returns TKey
Returns CollectorFunction<T, Map<TKey, T[]>>

groupByRecord

groupByRecord<T, TKey>(keySelector: ((entry: T) => TKey)): CollectorFunction<T, Record<TKey, T[]>>

- Defined in collectors/groupByRecord/groupByRecord.ts:4
Creates a group of entries where the group key is calculated by the selector function.

Type Parameters
- T
- TKey extends string | number | symbol
Parameters
- keySelector: ((entry: T) => TKey)
  - - (entry: T): TKey
    - Parameters
      - entry: T
      Returns TKey
Returns CollectorFunction<T, Record<TKey, T[]>>

includes

includes<T>(value: T, compareFunction?: ((a: T, b: T) => boolean)): CollectorFunction<T, boolean>

- Defined in collectors/contains/contains.ts:18
Type Parameters
- T
Parameters
- value: T
- compareFunction: ((a: T, b: T) => boolean) = ...
  - - (a: T, b: T): boolean
    - Parameters
      - a: T
      - b: T
      Returns boolean
Returns CollectorFunction<T, boolean>

isEmpty

isEmpty<T>(): CollectorFunction<T, boolean>

- Defined in collectors/isEmpty/isEmpty.ts:4
Returns true if the Iterable has 0 entry.

Type Parameters
- T
Returns CollectorFunction<T, boolean>

isNotNull

isNotNull<T>(value: undefined | null | T): value is NonNullable<T>

- Defined in operations/notNull/notNull.ts:4
Type Parameters
- T
Parameters
- value: undefined | null | T
Returns value is NonNullable<T>

join

join<T>(separator?: string): CollectorFunction<T, string>

- Defined in collectors/join/join.ts:5
Returns a string of all entries in the Iterable joined together seperated a given string.

Type Parameters
- T
Parameters
- separator: string = ','
Returns CollectorFunction<T, string>

last

last<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, T | undefined>

- Defined in collectors/last/last.ts:4
Returns the last entry from the Iterable that satisfy then 'predicate' function.

Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T | undefined>

lastIndex

lastIndex<T>(predicate?: ((item: T) => boolean)): CollectorFunction<T, number>

- Defined in collectors/lastIndex/lastIndex.ts:4
Returns the index of the last entry from the Iterable that satisfy then 'predicate' function.

Type Parameters
- T
Parameters
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, number>

lastOrDefault

lastOrDefault<T>(defaultValue: T, predicate?: ((item: T) => boolean)): CollectorFunction<T, T | undefined>

- Defined in collectors/lastOrDefault/lastOrDefault.ts:4
Returns the last entry from the Iterable that satisfy then 'predicate' function.

Type Parameters
- T
Parameters
- defaultValue: T
- predicate: ((item: T) => boolean) = ...
  - - (item: T): boolean
    - Parameters
      - item: T
      Returns boolean
Returns CollectorFunction<T, T | undefined>

length

length<T>(): CollectorFunction<T, number>

- Defined in collectors/count/count.ts:15
Type Parameters
- T
Returns CollectorFunction<T, number>

map

map<T, O>(func: ((value: T, index: number) => O)): OperationFunction<T, O>

- Defined in operations/map/map.ts:24
Returns an Iterable that yields entries of the source Iterable transformed using the function

Type Parameters
- T
- O
Parameters
- func: ((value: T, index: number) => O)
  - - (value: T, index: number): O
    - Parameters
      - value: T
      - index: number
      Returns O
Returns OperationFunction<T, O>

max

max(): CollectorFunction<number, number | undefined>

- Defined in collectors/max/max.ts:5
Return the largest value of all entries in the Iterable

Returns CollectorFunction<number, number | undefined>

maxBy

maxBy<T>(comparer: ((a: T, b: T) => number)): CollectorFunction<T, T | undefined>

- Defined in collectors/maxBy/maxBy.ts:5
Return the largest value of all entries in the Iterable based on the comparer function

Type Parameters
- T
Parameters
- comparer: ((a: T, b: T) => number)
  - - (a: T, b: T): number
    - Parameters
      - a: T
      - b: T
      Returns number
Returns CollectorFunction<T, T | undefined>

min

min(): CollectorFunction<number, number | undefined>

- Defined in collectors/min/min.ts:5
Return the smallest value of all entries in the Iterable

Returns CollectorFunction<number, number | undefined>

minBy

minBy<T>(comparer: ((a: T, b: T) => number)): CollectorFunction<T, T | undefined>

- Defined in collectors/minBy/minBy.ts:5
Return the smallest value of all entries in the Iterable based on the comparer function

Type Parameters
- T
Parameters
- comparer: ((a: T, b: T) => number)
  - - (a: T, b: T): number
    - Parameters
      - a: T
      - b: T
      Returns number
Returns CollectorFunction<T, T | undefined>

noop

noop<T>(): OperationFunction<T, T>

- Defined in operations/noop/noop.ts:4
Simply returns every entry from the source Iterable

Type Parameters
- T
Returns OperationFunction<T, T>

notNull

notNull<T>(): OperationFunction<T | undefined | null, NonNullable<T>>

- Defined in operations/notNull/notNull.ts:11
Returns an Iterable that yields only the non-null / non-undefined entries of the source Iterable.

Type Parameters
- T
Returns OperationFunction<T | undefined | null, NonNullable<T>>

of

of<T>(...entries: T[]): Stream<T>

- Defined in creators/of/of.ts:6
Return a Stream from the parameter entries

Type Parameters
- T
Parameters
- Rest ...entries: T[]
Returns Stream<T>

ofType

ofType<T, TOfType>(predicate: ((item: T) => item is TOfType)): OperationFunction<T, TOfType>

- Defined in operations/ofType/ofType.ts:30
Returns and casts an Iterable that yields only entries of the source Iterable that satisfy the given type-guard function.

Type Parameters
- T
- TOfType
Parameters
- predicate: ((item: T) => item is TOfType)
  - - (item: T): item is TOfType
    - Parameters
      - item: T
      Returns item is TOfType
Returns OperationFunction<T, TOfType>

pairwise

pairwise<T>(): OperationFunction<T, [T, T]>

- Defined in operations/pairwise/pairwise.ts:33
Returns an Iterable that yields the current and the previous entry of the source Iterable.

Type Parameters
- T
Returns OperationFunction<T, [T, T]>

range

range(start: number, count: number, by?: number): Stream<number>

- Defined in creators/range/range.ts:22
Returns a Stream that yields a range of values.

Parameters
- start: number
- count: number
- by: number = 1
Returns Stream<number>

reduce

reduce<T, O>(reducerFunction: ((previousValue: O, currentValue: T, currentIndex: number) => O), initialValue: O): CollectorFunction<T, O>

- Defined in collectors/reduce/reduce.ts:4
Executes a reducer function on each entry of the Iterable, resulting in a single output value.

Type Parameters
- T
- O
Parameters
- reducerFunction: ((previousValue: O, currentValue: T, currentIndex: number) => O)
  - - (previousValue: O, currentValue: T, currentIndex: number): O
    - Parameters
      - previousValue: O
      - currentValue: T
      - currentIndex: number
      Returns O
- initialValue: O
Returns CollectorFunction<T, O>

repeat

repeat<T>(value: T, times?: number): Stream<T>

- Defined in creators/repeat/repeat.ts:24
Returns a Stream that yields the value a specified number of times, or indefinitely if the 'times' parameter is omitted.

Type Parameters
- T
Parameters
- value: T
- times: number = Number.POSITIVE_INFINITY
Returns Stream<T>

skip

skip<T>(count: number): OperationFunction<T, T>

- Defined in operations/skip/skip.ts:27
Returns an Iterable skipping the given amount of entries of the source Iterable.

Type Parameters
- T
Parameters
- count: number
Returns OperationFunction<T, T>

skipWhile

skipWhile<T>(predicate: ((entry: T) => boolean)): OperationFunction<T, T>

- Defined in operations/skipWhile/skipWhile.ts:29
Returns an Iterable skipping entries of the source Iterable while the parameter function returns true.

Type Parameters
- T
Parameters
- predicate: ((entry: T) => boolean)
  - - (entry: T): boolean
    - Parameters
      - entry: T
      Returns boolean
Returns OperationFunction<T, T>

some

some<T>(predicate?: ((item: T, index: number) => boolean)): CollectorFunction<T, boolean>

- Defined in collectors/any/any.ts:18
Type Parameters
- T
Parameters
- predicate: ((item: T, index: number) => boolean) = ...
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns CollectorFunction<T, boolean>

sum

sum(): CollectorFunction<number, number | undefined>

- Defined in collectors/sum/sum.ts:5
Return the sum of all entries in the Iterable

Returns CollectorFunction<number, number | undefined>

take

take<T>(count: number): OperationFunction<T, T>

- Defined in operations/take/take.ts:19
Returns an Iterable taking the given amount of entries of the source Iterable.

Type Parameters
- T
Parameters
- count: number
Returns OperationFunction<T, T>

takeWhile

takeWhile<T>(predicate: ((entry: T) => boolean)): OperationFunction<T, T>

- Defined in operations/takeWhile/takeWhile.ts:20
Returns an Iterable taking entries of the source Iterable while the parameter function returns true.

Type Parameters
- T
Parameters
- predicate: ((entry: T) => boolean)
  - - (entry: T): boolean
    - Parameters
      - entry: T
      Returns boolean
Returns OperationFunction<T, T>

tap

tap<T>(callback: ((item: T) => void)): OperationFunction<T, T>

- Defined in operations/tap/tap.ts:23
Calls a callback function on each entry

Type Parameters
- T
Parameters
- callback: ((item: T) => void)
  - - (item: T): void
    - Parameters
      - item: T
      Returns void
Returns OperationFunction<T, T>

toArray

toArray<T>(): CollectorFunction<T, T[]>

- Defined in collectors/toArray/toArray.ts:4
Creates an Array from an Iterable

Type Parameters
- T
Returns CollectorFunction<T, T[]>

toMap

toMap<T, TKey, TValue>(keySelector: ((entry: T) => TKey), valueSelector: ((entry: T) => TValue)): CollectorFunction<T, Map<TKey, TValue>>

- Defined in collectors/toMap/toMap.ts:4
Creates a Map from an Iterable

Type Parameters
- T
- TKey
- TValue
Parameters
- keySelector: ((entry: T) => TKey)
  - - (entry: T): TKey
    - Parameters
      - entry: T
      Returns TKey
- valueSelector: ((entry: T) => TValue)
  - - (entry: T): TValue
    - Parameters
      - entry: T
      Returns TValue
Returns CollectorFunction<T, Map<TKey, TValue>>

toRecord

toRecord<T, TKey, TValue>(keySelector: ((entry: T) => TKey), valueSelector: ((entry: T) => TValue)): CollectorFunction<T, Record<TKey, TValue>>

- Defined in collectors/toRecord/toRecord.ts:4
Creates a Map from an Iterable

Type Parameters
- T
- TKey extends string | number | symbol
- TValue
Parameters
- keySelector: ((entry: T) => TKey)
  - - (entry: T): TKey
    - Parameters
      - entry: T
      Returns TKey
- valueSelector: ((entry: T) => TValue)
  - - (entry: T): TValue
    - Parameters
      - entry: T
      Returns TValue
Returns CollectorFunction<T, Record<TKey, TValue>>

toSet

toSet<T>(): CollectorFunction<T, Set<T>>

- Defined in collectors/toSet/toSet.ts:4
Creates a Set from an Iterable

Type Parameters
- T
Returns CollectorFunction<T, Set<T>>

toSortedArray

toSortedArray<T>(comparer: ((a: T, b: T) => number), ascending?: boolean): CollectorFunction<T, T[]>

- Defined in collectors/toSortedArray/toSortedArray.ts:4
Creates an Array from an Iterable

Type Parameters
- T
Parameters
- comparer: ((a: T, b: T) => number)
  - - (a: T, b: T): number
    - Parameters
      - a: T
      - b: T
      Returns number
- ascending: boolean = true
Returns CollectorFunction<T, T[]>

truthy

truthy<T>(): OperationFunction<T, T>

- Defined in operations/truthy/truthy.ts:5
Returns an Iterable that yields only entries of the source Iterable with truthy value.

Type Parameters
- T
Returns OperationFunction<T, T>

zip

zip<A, B, O>(a: Iterable<A>, b: Iterable<B>, zipFunction: ((a: A, b: B) => O)): Stream<O>

- Defined in creators/zip/zip.ts:27
Returns a Stream that merges elements from both iterables by taking one element from each, passing them to the function, and yielding the result.

Type Parameters
- A
- B
- O
Parameters
- a: Iterable<A>
- b: Iterable<B>
- zipFunction: ((a: A, b: B) => O)
  - - (a: A, b: B): O
    - Parameters
      - a: A
      - b: B
      Returns O
Returns Stream<O>

Index

Classes

Type Aliases

Functions

Type Aliases

CollectorFunction

Type Parameters

TInput

TOutput

Type declaration

Parameters

stream: Iterable<TInput>

Returns TOutput

OperationFunction

Type Parameters

TInput

TOutput

Type declaration

Parameters

entries: Iterable<TInput>

Returns Iterable<TOutput>

Functions

all

Type Parameters

T

Parameters

predicate: ((item: T, index: number) => boolean)

Parameters

item: T

index: number

Returns boolean

Returns CollectorFunction<T, boolean>

any

Type Parameters

T

Parameters

predicate: ((item: T, index: number) => boolean) = ...

Parameters

item: T

index: number

Returns boolean

Returns CollectorFunction<T, boolean>

appendWith

Type Parameters

T

Parameters

Rest ...iterables: Iterable<T>[]

Returns OperationFunction<T, T>

arrayFilter

Type Parameters

T

Parameters

func: ((entry: T, index: number, array: T[]) => boolean)

Parameters

entry: T

index: number

array: T[]

Returns boolean

Returns OperationFunction<T[], T[]>

arrayMap

Type Parameters

T

O

Parameters

func: ((entry: T, index: number, array: T[]) => O)

Parameters

entry: T

index: number

array: T[]

Returns O

Returns OperationFunction<T[], O[]>

buffer

Type Parameters

T

Parameters

size: number

Returns OperationFunction<T, T[]>

compound

Type Parameters

T