Gatherer
Defined in: src/stream/Gatherers.ts:14
A custom intermediate operation for stream.gather(gatherer); only integrator() is required. The Gatherer
value holds the factories Gatherer.of / Gatherer.ofSequential and the default* sentinels; built-ins are in
Gatherers.
Extends
Section titled “Extends”Gatherer<T,A,R>
Type Parameters
Section titled “Type Parameters”T
A
R
Methods
Section titled “Methods”andThen()?
Section titled “andThen()?”
optionalandThen<RR>(that):Gatherer<T,any,RR>
Defined in: src/stream/Gatherer.ts:45
Returns a gatherer that feeds this one’s output into that; the same as gather(this).gather(that).
Type Parameters
Section titled “Type Parameters”RR
Parameters
Section titled “Parameters”Gatherer<R, any, RR>
Returns
Section titled “Returns”Gatherer<T, any, RR>
Inherited from
Section titled “Inherited from”GathererType.andThen
combiner()?
Section titled “combiner()?”
optionalcombiner(): (left,right) =>A
Defined in: src/stream/Gatherer.ts:41
Merges two states in parallel evaluation; the default combiner marks a gatherer sequential-only.
Returns
Section titled “Returns”(left, right) => A
Inherited from
Section titled “Inherited from”GathererType.combiner
finisher()?
Section titled “finisher()?”
optionalfinisher(): (state,downstream) =>void
Defined in: src/stream/Gatherer.ts:43
Returns the function run once at the end (after the last element or a stop); it may push what the state still holds.
Returns
Section titled “Returns”(state, downstream) => void
Inherited from
Section titled “Inherited from”GathererType.finisher
initializer()?
Section titled “initializer()?”
optionalinitializer(): () =>A
Defined in: src/stream/Gatherer.ts:37
Returns the function that creates the state, called once per evaluation.
Returns
Section titled “Returns”() => A
Inherited from
Section titled “Inherited from”GathererType.initializer
integrator()
Section titled “integrator()”integrator():
Integrator<A,T,R>
Defined in: src/stream/Gatherer.ts:39
Returns the Integrator called for each upstream element.
Returns
Section titled “Returns”Integrator<A, T, R>
Inherited from
Section titled “Inherited from”GathererType.integrator