Skip to content

@epikodelabs/streamix


@epikodelabs/streamix / DROPPED

Function: DROPPED()

DROPPED<R>(value): object

Defined in: projects/libraries/streamix/src/lib/abstractions/operator.ts:54

Factory function to create a dropped stream result.

A dropped result signals that a value was suppressed by the operator (e.g. by filter, skip, debounce, etc.) but the iterator still yields to allow backpressure to be released and to enable introspection without terminating the stream. Downstream operators that receive a dropped result must propagate it unchanged rather than treating it as a real emission.

Type Parameters

R

R = any

The type of the suppressed value.

Parameters

value

R

The value that was suppressed.

Returns

object

An IteratorResult<R> object with { done: false, value, dropped: true }.

done

readonly done: false

value

readonly value: R

dropped

readonly dropped: true

Released under the GNU AGPL v3 or later.