Interface TransformedSignal<TIn, TOut>

This is like a writable signal, but the inputs and outputs are different types.

interface TransformedSignal<TIn, TOut> {
    [SIGNAL]: unknown;
    asReadonly(): Signal<TOut>;
    set(value: TIn): void;
    update(updateFn: ((value: TIn) => TIn)): void;
    (): TOut;
}

Type Parameters

TIn
The input type used in set and update.
TOut
The output type used in asReadonly or when this is called as a signal.

Hierarchy (view full)

Signal<TOut>
- TransformedSignal
  - MapSignal
  - MediaQuerySignal

TransformedSignal(): TOut
Returns TOut
- Defined in projects/signal-generators/src/lib/internal/transformed-signal.ts:8

Index

Methods

asReadonly set update

Properties

Methods

asReadonly

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

Returns Signal<TOut>
- Defined in projects/signal-generators/src/lib/internal/transformed-signal.ts:10

set

set(value): void
Sets the input value of the signal.
Parameters
- value: TIn
Returns void
- Defined in projects/signal-generators/src/lib/internal/transformed-signal.ts:12

update

update(updateFn): void
Updates the input value of the signal.
Parameters
- updateFn: ((value: TIn) => TIn)
  - - (value): TIn
    - Parameters
      value: TIn
      Returns TIn
Returns void
- Defined in projects/signal-generators/src/lib/internal/transformed-signal.ts:14

Properties

[SIGNAL]

[SIGNAL]: unknown