class Base<I,O,S>

A base class that can be used to easily create Reducer instances.

Implements: Reducer.Impl<I,O,S>

Type parameters

Name	Description
I	the input value type
O	the output value type
S	the internal state type

Properties

init

undocumented

Definition

readonly init: (initHalt: () => void) => S;

Overrides

Impl.init

mapInput

Returns a Reducer instance that converts its input values using given mapFun before passing them to this reducer.

Definition

mapInput: <I2>(mapFun: (value: I2, index: number) => I) => Reducer<I2, O>;

example

Reducer.sum.mapInput(v => v * 2)
// this reducer will double all input values before summing them

Overrides

Impl.mapInput

next

undocumented

Definition

readonly next: (state: S, elem: I, index: number, halt: () => void) => S;

stateToResult

undocumented

Definition

readonly stateToResult: (state: S, index: number, halted: boolean) => O;

Methods

chain

undocumented

Definition

chain<O2 extends O>(nextReducers: StreamSource<OptLazy<Reducer<I, O2>, [O2]>>): Reducer<I, O2>;

Type parameters

Name	Constraints	Description
O2	O

Parameters

Name	Type	Description
nextReducers	StreamSource<OptLazy<Reducer<I, O2>, [O2]>>

Overrides

Impl.chain

collectInput

undocumented

Definition

collectInput<I2>(collectFun: CollectFun<I2, I>): Reducer<I2, O>;

Type parameters

Name	Description
I2

Parameters

Name	Type	Description
collectFun	CollectFun<I2, I>

Overrides

Impl.collectInput

compile

undocumented

Definition

compile(): Reducer.Instance<I, O>;

Overrides

Impl.compile

dropInput

undocumented

Definition

dropInput(amount: number): Reducer<I, O>;

Parameters

Name	Type	Description
amount	number

Overrides

Impl.dropInput

filterInput

undocumented

Definition

filterInput(pred: (value: I, index: number, halt: () => void) => boolean, options?: {
      negate?: boolean | undefined;
    }): any;

Parameters

Name	Type	Description
pred	(value: I, index: number, halt: () => void) => boolean
options	{       negate?: boolean | undefined;     }

Overrides

Impl.filterInput

flatMapInput

undocumented

Definition

flatMapInput<I2>(flatMapFun: (value: I2, index: number) => StreamSource<I>): Reducer<I2, O>;

Type parameters

Name	Description
I2

Parameters

Name	Type	Description
flatMapFun	(value: I2, index: number) => StreamSource<I>

Overrides

Impl.flatMapInput

mapInput

undocumented

Definition

mapInput<I2>(mapFun: (value: I2, index: number) => I): Reducer<I2, O>;

Type parameters

Name	Description
I2

Parameters

Name	Type	Description
mapFun	(value: I2, index: number) => I

mapOutput

undocumented

Definition

mapOutput<O2>(mapFun: (value: O, index: number, halted: boolean) => O2): Reducer<I, O2>;

Type parameters

Name	Description
O2

Parameters

Name	Type	Description
mapFun	(value: O, index: number, halted: boolean) => O2

Overrides

Impl.mapOutput

next

Returns the next state based on the given input values:

Definition

next(state: S, elem: I, index: number, halt: () => void): S;

Parameters

Name	Type	Description
state	S	the current state
elem	I	the current input value
index	number	the current input index
halt	() => void	a function that, when called, ensures no more values are passed to the reducer

Overrides

Impl.next

sliceInput

undocumented

Definition

sliceInput(from?: number, amount?: number): Reducer<I, O>;

Parameters

Name	Type	Description
from	number
amount	number

Overrides

Impl.sliceInput

stateToResult

Returns the output value based on the given state.

Definition

stateToResult(state: S, index: number, halted: boolean): O;

Parameters

Name	Type	Description
state	S	the current state
index	number	the value index
halted	boolean	a boolean indicating whether the reducer is halted

Overrides

Impl.stateToResult

takeInput

undocumented

Definition

takeInput(amount: number): Reducer<I, O>;

Parameters

Name	Type	Description
amount	number

Overrides

Impl.takeInput

takeOutput

undocumented

Definition

takeOutput(amount: number): Reducer<I, O>;

Parameters

Name	Type	Description
amount	number

Overrides

Impl.takeOutput

takeOutputUntil

undocumented

Definition

takeOutputUntil(pred: (value: O, index: number) => boolean, options?: {
      negate?: boolean;
    }): Reducer<I, O>;

Parameters

Name	Type	Description
pred	(value: O, index: number) => boolean
options	{       negate?: boolean;     }

Overrides

Impl.takeOutputUntil