/stream/main/index.ts | rimbu@1.1.0

import * as rimbu from "https://deno.land/x/rimbu@1.1.0/stream/main/index.ts";

Namespaces

N AsyncReducer
N AsyncStream
N AsyncStreamable
N AsyncStreamSource
N AsyncTransformer
N Reducer
N Stream
N Streamable
N StreamSource
N Transformer

Classes

c AsyncReducer.Base	A base class that can be used to easily create `AsyncReducer` instances.
c AsyncReducer.InstanceImpl
c AsyncReducer.InvalidCombineShapeError
c AsyncReducer.ReducerHaltedError
c Reducer.Base	A base class that can be used to easily create `Reducer` instances.
c Reducer.InstanceImpl
c Reducer.InvalidCombineShapeError
c Reducer.ReducerHaltedError

Variables

v AsyncReducer.and	Returns an `AsyncReducer` that takes boolean values and outputs true if all input values are true, and false otherwise.
v AsyncReducer.average	A `Reducer` that calculates the average of all given numberic input values.
v AsyncReducer.count	Returns an `AsyncReducer` that remembers the amount of input items provided.
v AsyncReducer.first	Returns an `AsyncReducer` that remembers the first input value.
v AsyncReducer.firstWhere	Returns an `AsyncReducer` that remembers the first input value for which the given `pred` function returns true.
v AsyncReducer.isEmpty	Returns an `AsyncReducer` that outputs true if no input values are received, false otherwise.
v AsyncReducer.last	Returns an `AsyncReducer` that remembers the last input value.
v AsyncReducer.lastWhere	Returns an `AsyncReducer` that remembers the last input value for which the given `pred` function returns true.
v AsyncReducer.max	Returns a `Reducer` that remembers the maximum value of the numberic inputs.
v AsyncReducer.maxBy	Returns a `Reducer` that remembers the maximum value of the inputs using the given `compFun` to compare input values
v AsyncReducer.min	Returns a `Reducer` that remembers the minimum value of the numberic inputs.
v AsyncReducer.minBy	Returns a `Reducer` that remembers the minimum value of the inputs using the given `compFun` to compare input values
v AsyncReducer.nonEmpty	Returns an `AsyncReducer` that outputs true if one or more input values are received, false otherwise.
v AsyncReducer.or	Returns an `AsyncReducer` that takes boolean values and outputs true if one or more input values are true, and false otherwise.
v AsyncReducer.product	A `Reducer` that calculates the product of all given numeric input values.
v AsyncReducer.sum	A `Reducer` that sums all given numeric input values.
v AsyncStream
v AsyncTransformer.window	Returns an async transformer that produces windows/collections of `windowSize` size, each window starting `skipAmount` of elements after the previous, and optionally collected by a custom reducer.
v Reducer.and	Returns a `Reducer` that takes boolean values and outputs true if all input values are true, and false otherwise.
v Reducer.average	A `Reducer` that calculates the average of all given numberic input values.
v Reducer.count	Returns a `Reducer` that remembers the amount of input items provided.
v Reducer.first	Returns a `Reducer` that remembers the first input value.
v Reducer.firstWhere	Returns a `Reducer` that remembers the first input value for which the given `pred` function returns true.
v Reducer.isEmpty	Returns a `Reducer` that outputs true if no input values are received, false otherwise.
v Reducer.last	Returns a `Reducer` that remembers the last input value.
v Reducer.lastWhere	Returns a `Reducer` that remembers the last input value for which the given `pred` function returns true.
v Reducer.max	Returns a `Reducer` that remembers the maximum value of the numberic inputs.
v Reducer.maxBy	Returns a `Reducer` that remembers the maximum value of the inputs using the given `compFun` to compare input values
v Reducer.min	Returns a `Reducer` that remembers the minimum value of the numberic inputs.
v Reducer.minBy	Returns a `Reducer` that remembers the minimum value of the inputs using the given `compFun` to compare input values
v Reducer.nonEmpty	Returns a `Reducer` that outputs true if one or more input values are received, false otherwise.
v Reducer.or	Returns a `Reducer` that takes boolean values and outputs true if one or more input values are true, and false otherwise.
v Reducer.product	A `Reducer` that calculates the product of all given numeric input values.
v Reducer.sum	A `Reducer` that sums all given numeric input values.
v Stream
v Transformer.window	Returns a transformer that produces windows/collections of `windowSize` size, each window starting `skipAmount` of elements after the previous, and optionally collected by a custom reducer.

Functions

f AsyncReducer.combine	Returns a `Reducer` that combines multiple input `reducers` according to the given "shape" by providing input values to all of them and collecting the outputs in the shape.
f AsyncReducer.contains	Returns an `AsyncReducer` that outputs false as long as the given `elem` has not been encountered in the input values, true otherwise.
f AsyncReducer.create	Returns an `AsyncReducer` with the given options:
f AsyncReducer.createMono	Returns an `AsyncReducer` of which the input, state, and output types are the same.
f AsyncReducer.createOutput	Returns an `AsyncReducer` of which the state and output types are the same.
f AsyncReducer.every	Returns an `AsyncReducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
f AsyncReducer.from
f AsyncReducer.join	Returns a `Reducer` that joins the given input values into a string using the given options.
f AsyncReducer.some	Returns a `Reducer` that ouputs false as long as no input value satisfies given `pred`, true otherwise.
f AsyncReducer.toArray	Returns an `AsyncReducer` that collects received input values in an array, and returns a copy of that array as an output value when requested.
f AsyncReducer.toJSMap	Returns a `AsyncReducer` that collects received input tuples into a mutable JS Map, and returns a copy of that map when output is requested.
f AsyncReducer.toJSObject	Returns an `AsyncReducer` that collects 2-tuples containing keys and values into a plain JS object, and returns a copy of that object when output is requested.
f AsyncReducer.toJSSet	Returns an `AsyncReducer` that collects received input values into a mutable JS Set, and returns a copy of that map when output is requested.
f AsyncTransformer.distinctPrevious	Returns an async transformer that returns only those elements from the input that are different to previous element according to the optionally given `eq` function.
f Reducer.combine	Returns a `Reducer` that combines multiple input `reducers` according to the given "shape" by providing input values to all of them and collecting the outputs in the shape.
f Reducer.contains	Returns a `Reducer` that outputs false as long as the given `elem` has not been encountered in the input values, true otherwise.
f Reducer.create	Returns a `Reducer` with the given options:
f Reducer.createMono	Returns a `Reducer` of which the input, state, and output types are the same.
f Reducer.createOutput	Returns a `Reducer` of which the state and output types are the same.
f Reducer.every	Returns a `Reducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
f Reducer.fixed
f Reducer.join	Returns a `Reducer` that joins the given input values into a string using the given options.
f Reducer.some	Returns a `Reducer` that ouputs false as long as no input value satisfies given `pred`, true otherwise.
f Reducer.toArray	Returns a `Reducer` that collects received input values in an array, and returns a copy of that array as an output value when requested.
f Reducer.toJSMap	Returns a `Reducer` that collects received input tuples into a mutable JS Map, and returns a copy of that map when output is requested.
f Reducer.toJSObject	Returns a `Reducer` that collects 2-tuples containing keys and values into a plain JS object, and returns a copy of that object when output is requested.
f Reducer.toJSSet	Returns a `Reducer` that collects received input values into a mutable JS Set, and returns a copy of that map when output is requested.
f Transformer.distinctPrevious	Returns a transformer that returns only those elements from the input that are different to previous element according to the optionally given `eq` function.

Interfaces

I AsyncFastIterable
I AsyncFastIterator
I AsyncReducer.Impl
I AsyncReducer.Instance
I AsyncStream	A possibly infinite asynchronous sequence of elements of type T. See the Stream documentation and the AsyncStream API documentation
I AsyncStream.NonEmpty	A non-empty and possibly infinite asynchronous sequence of elements of type T. See the Stream documentation and the AsyncStream API documentation
I AsyncStreamable
I AsyncStreamable.NonEmpty
I FastIterable	An interface that extends the standard `Iterable` interface to return a `FastIterator` instead of a normal `Iterator`.
I FastIterator	An iterator that extends the default `Iterator` interface with methods that give more performance.
I Reducer.Impl	The Implementation interface for a `Reducer`, which also exposes the internal state type.
I Reducer.Instance
I Stream	A possibly infinite sequence of elements of type T. See the Stream documentation and the Stream API documentation
I Stream.NonEmpty	A non-empty and possibly infinite sequence of elements of type T. See the Stream documentation and the Stream API documentation
I Streamable	An object that can create a Stream of elements of type `T`.
I Streamable.NonEmpty	An object that can create a non-empty Stream of elements of type `T`.

Type Aliases

T AsyncReducer	An `AsyncReducer` is a stand-alone asynchronous calculation that takes input values of type I, and, when requested, produces an output value of type O.
T AsyncReducer.CombineResult
T AsyncReducer.CombineShape
T AsyncStreamSource
T AsyncStreamSource.NonEmpty
T AsyncTransformer	An AsyncReducer that produces instances of `AsyncStreamSource`.
T AsyncTransformer.NonEmpty	An AsyncReducer that produces instances `AsyncStreamSource.NonEmpty`.
T Reducer	A `Reducer` is a stand-alone calculation that takes input values of type I, and, when requested, produces an output value of type O.
T Reducer.CombineResult
T Reducer.CombineShape
T StreamSource	Any object that is Iterable, a Stream, or can produce a Stream.
T StreamSource.NonEmpty	Any object that is a non-empty Stream, can produce a non-empty Stream, or is a non-empty array.
T Transformer	A Reducer that produces instances of `StreamSource`.
T Transformer.NonEmpty	A Reducer that produces instances of `StreamSource.NonEmpty`.