Interface FilterSignal<T, O>

The signal returned from filterSignal.

interface FilterSignal<T, O = T> {
    "[SIGNAL]": unknown;
    asReadonly(): Signal<O>;
    set(value: T): void;
    update(updateFn: (value: O) => T): void;
    (): O;
}

Type Parameters

T
O = T

Hierarchy

Signal<O>
- FilterSignal

FilterSignal(): O
Returns O
- Defined in projects/signal-generators/src/lib/signals/filter-signal.ts:6

Index

Methods

asReadonly set update

Properties

Methods

asReadonly

asReadonly(): Signal<O>
Returns the output signal as a readonly.

Returns Signal<O>
- Defined in projects/signal-generators/src/lib/signals/filter-signal.ts:8

set

set(value: T): void
Sets the new value IF it is compatible with the filter function.
Parameters
- value: T
Returns void
- Defined in projects/signal-generators/src/lib/signals/filter-signal.ts:10

update

update(updateFn: (value: O) => T): void
Updates the signal's value IF it is compatible with the filter function.
Parameters
- updateFn: (value: O) => T
Returns void
- Defined in projects/signal-generators/src/lib/signals/filter-signal.ts:12

Properties

[SIGNAL]

"[SIGNAL]": unknown