/stream/mod.ts | rimbu@1.2.0

import * as rimbu from "https://deno.land/x/rimbu@1.2.0/stream/mod.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	The default `AsyncReducer.Impl` implementation.
c AsyncReducer.InvalidCombineShapeError
c AsyncReducer.ReducerClosedError
c AsyncReducer.ReducerHaltedError
c AsyncReducer.ReducerNotInitializedError
c Reducer.Base	A base class that can be used to easily create `Reducer` instances.
c Reducer.InstanceImpl	The default `Reducer.Impl` implementation.
c Reducer.InvalidCombineShapeError
c Reducer.ReducerHaltedError

Variables

v AsyncReducer.first	Returns an `AsyncReducer` that remembers the first input value.
v AsyncReducer.groupBy	Returns an `AsyncReducer` that uses the `valueToKey` function to calculate a key for each value, and feeds the tuple of the key and the value to the `collector` reducer. Finally, it returns the output of the `collector`. If no collector is given, the default collector will return a JS multimap of the type `Map<K, V[]>`.
v AsyncReducer.isEmpty	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.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	An `AsyncReducer` that outputs true if one or more input values are received, false otherwise.
v AsyncReducer.partition	Returns an `AsyncReducer` that splits the incoming values into two separate outputs based on the given `pred` predicate. Values for which the predicate is true are fed into the `collectorTrue` reducer, and other values are fed into the `collectorFalse` instance. If no collectors are provided the values are collected into arrays.
v AsyncReducer.race	Returns an `AsyncReducer` that feeds incoming values to all reducers in the provided `reducers` source, and halts when the first reducer in the array is halted and returns the output of that reducer. Returns the `otherwise` value if no reducer is yet halted.
v AsyncReducer.single	Returns an AsyncReducer that only produces an output value when having receives exactly one input value, otherwise will return the `otherwise` value or undefined.
v AsyncStream
v AsyncTransformer.filter	Returns an async transformer that filters elements from the input stream based on the provided predicate function.
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	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	A `Reducer` that remembers the amount of input items provided.
v Reducer.first	Returns a `Reducer` that remembers the first input value.
v Reducer.groupBy	Returns a `Reducer` that uses the `valueToKey` function to calculate a key for each value, and feeds the tuple of the key and the value to the `collector` reducer. Finally, it returns the output of the `collector`. If no collector is given, the default collector will return a JS multimap of the type `Map<K, V[]>`.
v Reducer.isEmpty	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.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	A `Reducer` that outputs true if one or more input values are received, false otherwise.
v Reducer.or	A `Reducer` that takes boolean values and outputs true if one or more input values are true, and false otherwise.
v Reducer.partition	Returns a `Reducer` that splits the incoming values into two separate outputs based on the given `pred` predicate. Values for which the predicate is true are fed into the `collectorTrue` reducer, and other values are fed into the `collectorFalse` instance. If no collectors are provided the values are collected into arrays.
v Reducer.product	A `Reducer` that calculates the product of all given numeric input values.
v Reducer.race	Returns a `Reducer` that feeds incoming values to all reducers in the provided `reducers` source, and halts when the first reducer in the array is halted and returns the output of that reducer. Returns the `otherwise` value if no reducer is yet halted.
v Reducer.single	Returns a Reducer that only produces an output value when having receives exactly one input value, otherwise will return the `otherwise` value or undefined.
v Reducer.sum	A `Reducer` that sums all given numeric input values.
v Stream
v Transformer.filter	Returns a transformer that filters elements from the input stream based on the provided predicate function.
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 an `AsyncReducer` 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.containsSlice	Returns an `AsyncReducer` that returns true if the input values contain the given `slice` sequence `amount` times. Otherwise, returns false.
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.endsWithSlice	Returns an `AsyncReducer` that returns true if the last input values match the given `slice` values repeated `amount` times. Otherwise, returns false.
f AsyncReducer.equals	Returns an `AsyncReducer` that ouputs true when the received elements match the given `other` async stream source according to the `eq` instance, false otherwise.
f AsyncReducer.every	Returns an `AsyncReducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
f AsyncReducer.fold	Returns an `AsyncReducer` that uses the given `init` and `next` values to fold the input values into result values.
f AsyncReducer.from	Returns an `AsyncReducer` from a given `Reducer` or `AsyncReducer` instance.
f AsyncReducer.some	Returns an `AsyncReducer` that ouputs false as long as no input value satisfies given `pred`, true otherwise.
f AsyncReducer.startsWithSlice	Returns a `AsyncReducer` that returns true if the first input values match the given `slice` values repeated `amount` times. Otherwise, returns false.
f AsyncTransformer.collect	Returns an `AsyncTransformer` instance that converts or filters its input values using given `collectFun` before passing them to the reducer.
f AsyncTransformer.flatMap	Returns an async transformer that applies the given flatMap function to each element of the input stream, and concatenates all the resulting resulting streams into one stream.
f AsyncTransformer.flatZip	Returns an async transformer that applies the given flatMap function to each element of the input stream, and concatenates all the resulting resulting streams into one stream, where each resulting element is tupled with the originating input element.
f AsyncTransformer.from	Returns an AsyncTransformer based on a given synchronous or asynchronous transformer.
f AsyncTransformer.indicesWhere	Returns an `AsyncTransformer` that outputs the index of each received element that satisfies the given predicate.
f AsyncTransformer.intersperse	Returns an `AsyncTransformer` that inserts the given `sep` stream source elements between each received input element.
f AsyncTransformer.splitOn	Returns an `AsyncTransformer` that collects the received elements into a `collector` that will be returned as output every time the input matches the given `sepElem` value.
f AsyncTransformer.splitOnSlice	Returns an `AsyncTransformer` that collects the received elements into a `collector` that will be returned as output every time the input matches the given `sepSlice` sequence of elements.
f AsyncTransformer.splitWhere	Returns an `AsyncTransformer` that applies the given `pred` function to each received element, and collects the received elements into a `collector` that will be returned as output every time the predicate returns true.
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.constant	Returns a `Reducer` that always outputs the given `value`, and does not accept input values.
f Reducer.contains	Returns a `Reducer` that outputs false as long as the given `elem` has not been encountered the given `amount` of times in the input values, true otherwise.
f Reducer.containsSlice	Returns a `Reducer` that returns true if the input values contain the given `slice` sequence `amount` times. Otherwise, returns false.
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.endsWithSlice	Returns a `Reducer` that returns true if the last input values match the given `slice` values repeated `amount` times. Otherwise, returns false.
f Reducer.equals	Returns a `Reducer` that ouputs true when the received elements match the given `other` stream source according to the `eq` instance, false otherwise.
f Reducer.every	Returns a `Reducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
f Reducer.fold	Returns a `Reducer` that uses the given `init` and `next` values to fold the input values into result values.
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.startsWithSlice	Returns a `Reducer` that returns true if the first input values match the given `slice` values repeated `amount` times. Otherwise, returns false.
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.toJSMultiMap	Returns a `Reducer` that collects received input tuples into a mutable JS multimap, 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.collect	Returns a `Transformer` instance that converts or filters its input values using given `collectFun` before passing them to the reducer.
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.
f Transformer.flatMap	Returns a transformer that applies the given flatMap function to each element of the input stream, and concatenates all the resulting resulting streams into one stream.
f Transformer.flatZip	Returns a transformer that applies the given flatMap function to each element of the input stream, and concatenates all the resulting resulting streams into one stream, where each resulting element is tupled with the originating input element.
f Transformer.indicesOf	Returns a `Transformer` that outputs the index of each received element that is equal to the given `searchValue` value, according to the `eq` equality function.
f Transformer.indicesWhere	Returns a `Transformer` that outputs the index of each received element that satisfies the given predicate.
f Transformer.intersperse	Returns a `Transfoemr` that inserts the given `sep` stream source elements between each received input element.
f Transformer.splitOn	Returns a `Transformer` that collects the received elements into a `collector` that will be returned as output every time the input matches the given `sepElem` value.
f Transformer.splitOnSlice	Returns a `Transformer` that collects the received elements into a `collector` that will be returned as output every time the input matches the given `sepSlice` sequence of elements.
f Transformer.splitWhere	Returns a `Transformer` that applies the given `pred` function to each received element, and collects the received elements into a `collector` that will be returned as output every time the predicate returns true.

Interfaces

I AsyncFastIterable
I AsyncFastIterator	An asynchronous iterator that extends the default `AsyncIterator` interface with methods for improved performance.
I AsyncReducer.Impl	The AsyncReducer implementation interface defining the required methods.
I AsyncReducer.Instance	An async reducer instance that manages its own state based on the reducer definition that was used to create this 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	Represents an object that can produce an asynchronous stream of values.
I AsyncStreamable.NonEmpty	Represents a non-empty object that can produce an asynchronous stream of values.
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	A reducer instance that manages its own state based on the reducer definition that was used to create this 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.Accept	Convenience type to allow synchronous reducers to be supplied to functions that accept async reducers.
T AsyncReducer.CombineResult	Type defining the result type of an async reducer combination for a given shape.
T AsyncReducer.CombineShape	Type defining the allowed shape of async reducer combinations.
T AsyncStreamSource
T AsyncStreamSource.NonEmpty
T AsyncTransformer	An AsyncReducer that produces instances of `AsyncStreamSource`.
T AsyncTransformer.Accept	Convenience type to allow synchronous transformers to be supplied to functions that accept async transformers.
T AsyncTransformer.AcceptNonEmpty	Convenience type to allow non-empty synchronous transformers to be supplied to functions that accept non-empty async transformers.
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	Type defining the result type of a reducer combination for a given shape.
T Reducer.CombineShape	Type defining the allowed shape of reducer combinations.
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`.