ConstReadonlyannotate: (<V, TAnnotation>(annotator: ((input: V) => V & TAnnotation)) => (<In, TAnnotation>(source: ReactiveOrSource<In>) => Reactive<{ ReadonlyannotateAnnotates the input stream using ReactiveOp as the source of annotations.
The output values will have the shape of { value: TIn, annotation: TAnnotation }.
Meaning that the original value is stored under .value, and the annotation under .annotation.
// Emit values from an array
const r1 = Rx.run(
Rx.From.array([ 1, 2, 3 ]),
Rx.Ops.annotateWithOp(
// Add the 'max' operator to emit the largest-seen value
Rx.Ops.sum()
)
);
const data = await Rx.toArray(r1);
// Data = [ { value: 1, annotation: 1 }, { value: 2, annotation: 3 }, { value: 3, annotation: 6 } ]
Readonlyaverage: (<TIn>(options?: OpMathOptions) => ((source: ReactiveOrSource<TIn>) => Reactive<number>))Optionaloptions: OpMathOptionsReadonlychunk: (<V>(options: Partial<ChunkOptions>) => ReactiveOp<V, V[]>)Takes a stream of values and chunks them up (by quantity or time elapsed), emitting them as an array.
ReadonlycloneReadonlycombineMerges values from several sources into a single source that emits values as an array.
ReadonlycombineMerges values from several sources into a single source that emits values as an object.
Readonlydebounce: (<V>(options: Partial<DebounceOptions>) => ReactiveOp<V, V>)Debounce values from the stream. It will wait until a certain time has elapsed before emitting latest value.
Effect is that no values are emitted if input emits faster than the provided timeout.
See also: throttle
Readonlydrop: (<V>(predicate: ((value: V) => boolean)) => (<In>(source: ReactiveOrSource<In>) => Reactive<In>))Drops values from the input stream that match predicate
Readonlyelapsed: (<V>() => ReactiveOp<V, number>)Every upstream value is considered the target for interpolation. Output value interpolates by a given amount toward the target.
Readonlyfield: (<TSource, TFieldType>(fieldName: keyof TSource, options: FieldOptions<TSource, TFieldType>) => ((source: ReactiveOrSource<TSource>) => Reactive<TFieldType>))Yields the value of a field from an input stream of values.
Eg if the source reactive emits { colour: string, size: number },
we might use field to pluck out the colour field, thus returning
a stream of string values.
Readonlyfilter: (<V>(predicate: ((value: V) => boolean)) => (<In>(source: ReactiveOrSource<In>) => Reactive<In>))Filters the input stream, only re-emitting values that pass the predicate
Readonlyinterpolate: (<TIn>(options?: Partial<OpInterpolateOptions>) => ((source: ReactiveOrSource<TIn>) => ReactivePingable<number>))Every upstream value is considered the target for interpolation. Output value interpolates by a given amount toward the target.
Optionaloptions: Partial<OpInterpolateOptions>Readonlymax: (<TIn>(options?: OpMathOptions) => ((source: ReactiveOrSource<TIn>) => Reactive<number>))Outputs the maxium numerical value of the stream. A value is only emitted when maximum increases.
Optionaloptions: OpMathOptionsReadonlymin: (<TIn>(options?: OpMathOptions) => ((source: ReactiveOrSource<TIn>) => Reactive<number>))Outputs the minimum numerical value of the stream. A value is only emitted when minimum decreases.
Optionaloptions: OpMathOptionsReadonlypipe: (<TInput, TOutput>(...streams: (Reactive<any> & { Rest...streams: (Reactive<any> & { Readonlyrank: (<TIn>(rank: RankFunction<TIn>, options?: RankOptions & Partial<InitStreamOptions> & { Optionaloptions: RankOptions & Partial<InitStreamOptions> & { ReadonlysingleReadonlysplit: (<V>(options?: Partial<SplitOptions>) => ((source: ReactiveOrSource<V>) => ReactiveStream<V>[]))ReadonlysplitReadonlysum: (<TIn>(options?: OpMathOptions) => ((source: ReactiveOrSource<TIn>) => Reactive<number>))Optionaloptions: OpMathOptionsReadonlyswitcher: (<TValue, TRec, TLabel>(cases: TRec, options?: Partial<SwitcherOptions>) => ((source: ReactiveOrSource<TValue>) => Record<TLabel, Reactive<TValue>>))ReadonlysyncReadonlysyncReadonlytally: (<TIn>(options?: TallyOptions) => ((source: ReactiveOrSource<TIn>) => Reactive<number>))Optionaloptions: TallyOptionsReadonlytapRest...ops: ReactiveOp<In, Out>[]ReadonlytapReadonlytapReadonlythrottle: (<V>(options: Partial<ThrottleOptions>) => ((source: ReactiveOrSource<V>) => Reactive<V>))Throttle values from the stream. Only emits a value if some minimum time has elapsed.
ReadonlytimeoutReadonlytimeoutTrigger a value if 'source' does not emit a value within an interval. Trigger value can be a fixed value, result of function, or step through an iterator.
Readonlytransform: (<In, Out>(transformer: ((value: In) => Out), options?: Partial<TransformOpts>) => ReactiveOp<In, Out>)ReadonlywithReactive where last (or a given initial) value is available to read
Annotates values with the result of a function. The input value needs to be an object.
For every value
inputemits, run it throughannotator, which should return the original value with additional fields.Conceptually the same as
transform, just with typing to enforce result values are V & TAnnotation