Buffers the source PipelineStage values until the size hits the maximum bufferSize given.
Input PipelineStage
The maximum size of the buffer emitted.
A PipelineStage of arrays of buffered values.
Handle errors raised in the pipeline as follows:
1) Default: raise the error 2) Use a handler function to returns a new PipelineStage in case of error
Source PipelineStage
Function called in case of error to generate a new PipelineStage
Output PipelineStage
Clone a PipelineStage
PipelineStage to clone
Cloned PipelineStage
Creates a PipelineStage which collect all items from the source PipelineStage into an array, and then emits this array.
Input PipelineStage
A PipelineStage which emits all values emitted by the source PipelineStage as an array
Emits given values if the source PipelineStage completes without emitting any next value, otherwise mirrors the source PipelineStage.
Input PipelineStage
A PipelineStage that emits either the specified default values if the source PipelineStage emits no items, or the values emitted by the source PipelineStage.
Returns a PipelineStage that emits all items emitted by the source PipelineStage that are distinct by comparison from previous items.
Input PipelineStage
Optional function to select which value you want to check as distinct.
A PipelineStage that emits items from the source PipelineStage with distinct values.
Creates a PipelineStage that emits no items
A PipelineStage that emits no items
Returns a PipelineStage that emits the items you specify as arguments after it finishes emitting items emitted by the source PipelineStage.
Input PipelineStage
Values to append
A PipelineStage that emits the items emitted by the source PipelineStage and then emits the additional values.
Filter items emitted by the source PipelineStage by only emitting those that satisfy a specified predicate.
Input PipelineStage
Predicate function
Output PipelineStage
Do something after the PipelineStage has produced all its results
Input PipelineStage
Function invoked after the PipelineStage has produced all its results
Output PipelineStage
Emits only the first value (or the first value that meets some condition) emitted by the source PipelineStage.
Input PipelineStage
A PipelineStage of the first item that matches the condition.
Maps each source value to an array of values which is merged in the output PipelineStage.
Input PipelineStage
Transformation function
Output PipelineStage
Flatten the output of a pipeline stage that emits array of values into single values.
Input PipelineStage
Output PipelineStage
Apply a callback on every item emitted by the source PipelineStage
Input PipelineStage
Callback
Creates a PipelineStage from an Array, an array-like object, a Promise, an iterable object, or an Observable-like object.
Source object
A PipelineStage that emits the values contains in the object
Creates a PipelineStage from a something that emits values asynchronously, using a StreamPipelineInput to feed values/errors into the pipeline.
Callback invoked with a StreamPipelineInput used to feed values inot the pipeline.
A PipelineStage that emits the values produces asynchronously
Groups the items produced by a pipeline according to a specified criterion, and emits the resulting groups
Input PipelineStage
A function that extracts the grouping key for each item
(optional) A function that transforms items before inserting them in a group
Emits only the first count values emitted by the source PipelineStage.
Input PipelineStage
How many items to take
A PipelineStage that emits only the first count values emitted by the source PipelineStage, or all of the values from the source if the source emits fewer than count values.
Applies a given mapper function to each value emitted by the source PipelineStage, and emits the resulting values as a PipelineStage.
Source PipelineStage
The function to apply to each value emitted by the source PipelineStage
A PipelineStage that emits the values from the source PipelineStage transformed by the given mapper function.
Find the smallest value produced by a pipeline of iterators. It takes a ranking function as input, which is invoked with (x, y) and must returns True if x > y and False otherwise. Warning: this function needs to materialize all values of the pipeline.
Input PipelineStage
A pipeline stage that emits the highest value found
Creates an output PipelineStage which concurrently emits all values from every given input PipelineStage.
Inputs PipelineStage
Output PipelineStage
Projects each source value to a PipelineStage which is merged in the output PipelineStage.
Input PipelineStage
Transformation function
Output PipelineStage
Find the smallest value produced by a pipeline of iterators. It takes a ranking function as input, which is invoked with (x, y) and must returns True if x < y and False otherwise. Warning: this function needs to materialize all values of the pipeline.
Input PipelineStage
A pipeline stage that emits the lowest value found
Converts the arguments to a PipelineStage
Values to convert
A PipelineStage that emits the values
Peek values from the input pipeline stage, and use them to decide between two candidate pipeline stages to continue the pipeline.
Input pipeline stage
How many items to peek from the input?
Predicate function invoked with the values
Callback invoked if the predicate function evaluates to True
Callback invoked if the predicate function evaluates to False
A pipeline stage
Applies an accumulator function over the source PipelineStage, and returns the accumulated result when the source completes, given an optional initial value.
Input PipelineStage
Accumulator function
A PipelineStage that emits a single value that is the result of accumulating the values emitted by the source PipelineStage.
Returns a PipelineStage that skips the first count items emitted by the source PipelineStage.
Input PipelineStage
How many items to skip
A PipelineStage that skips values emitted by the source PipelineStage.
Perform a side effect for every emission on the source PipelineStage, but return a PipelineStage that is identical to the source.
Input PipelineStage
Callback invoked on each item
A PipelineStage identical to the source, but runs the specified PipelineStage or callback(s) for each item.
Generated using TypeDoc
Abstract representation used to apply transformations on a pipeline of iterators. Concrete subclasses are used by the framework to build the query execution pipeline.
Thomas Minier