Interface WritableSignalConstructor

Creates a WritableSignal in an "unset" state.

If .get() is called before the Signal's value is updated, then an "unset" Error is thrown.

interface WritableSignalConstructor {
    new WritableSignalConstructor<GValue>(
        initialValue: SignalValueOrError<GValue>,
        options?: SignalOptions<GValue>,
    ): WritableSignalTrait<GValue>;
    thrown<GValue>(
        error: unknown,
        options?: SignalOptions<GValue>,
    ): WritableSignalTrait<GValue>;
    unset<GValue>(options?: SignalOptions<GValue>): WritableSignalTrait<GValue>;
}

Hierarchy (View Summary)

WritableSignalStaticUnsetTrait
WritableSignalStaticThrownTrait
- WritableSignalConstructor

Index

Constructors

Methods

Constructors

constructor

new WritableSignalConstructor<GValue>(
initialValue: SignalValueOrError<GValue>,
options?: SignalOptions<GValue>,
): WritableSignalTrait<GValue>
Type Parameters
- GValue
Parameters
- initialValue: SignalValueOrError<GValue>
- Optionaloptions: SignalOptions<GValue>
Returns WritableSignalTrait<GValue>
Inherited from WritableSignalStaticUnsetTrait.constructor
- Defined in src/transients/core/writable-signal/traits/writable-signal.constructor.ts:10

Methods

thrown

thrown<GValue>(
error: unknown,
options?: SignalOptions<GValue>,
): WritableSignalTrait<GValue>
Type Parameters
- GValue
Parameters
- error: unknown
- Optionaloptions: SignalOptions<GValue>
Returns WritableSignalTrait<GValue>
Inherited from WritableSignalStaticThrownTrait.thrown
- Defined in src/transients/core/writable-signal/traits/static/methods/writable-signal.static.thrown.trait.ts:10

unset

unset<GValue>(options?: SignalOptions<GValue>): WritableSignalTrait<GValue>
Type Parameters
- GValue
Parameters
- Optionaloptions: SignalOptions<GValue>
Returns WritableSignalTrait<GValue>
Inherited from WritableSignalStaticUnsetTrait.unset
- Defined in src/transients/core/writable-signal/traits/static/methods/writable-signal.static.unset.trait.ts:10