Class WritableSignal<GValue>

See

WritableSignalTrait

Type Parameters

GValue

Hierarchy (View Summary)

Signal<GValue>
- WritableSignal

Implements

WritableSignalTrait<GValue>

Index

Constructors

constructor

Methods

asReadonly capture get set takeSnapshot throw trackActivity update isInContext runInContext runOutsideContext thrown unset

Constructors

constructor

new WritableSignal<GValue>(
initialValue: SignalValueOrError<GValue>,
options?: SignalOptions<GValue>,
): WritableSignal<GValue>
Type Parameters
- GValue
Parameters
- initialValue: SignalValueOrError<GValue>
- Optionaloptions: SignalOptions<GValue>
Returns WritableSignal<GValue>
Overrides Signal.constructor
- Defined in src/transients/core/writable-signal/writable-signal.ts:29

Methods

asReadonly

asReadonly(): ReadonlySignal<GValue>
Returns ReadonlySignal<GValue>
See
WritableSignalAsReadonlyTrait
Implementation of WritableSignalTrait.asReadonly
- Defined in src/transients/core/writable-signal/writable-signal.ts:87

capture

capture(): void
Returns void
See
TransientCaptureTrait
Implementation of WritableSignalTrait.capture
Inherited from Signal.capture
- Defined in src/transients/core/signal/signal.ts:62

get

get(): GValue
Returns GValue
See
SignalGetTrait
Implementation of WritableSignalTrait.get
Inherited from Signal.get
- Defined in src/transients/core/signal/signal.ts:69

set

set(value: SignalValueOrError<GValue>): void
Parameters
- value: SignalValueOrError<GValue>
Returns void
See
WritableSignalSetTrait
Implementation of WritableSignalTrait.set
- Defined in src/transients/core/writable-signal/writable-signal.ts:52

takeSnapshot

takeSnapshot(): TransientSnapshotChanged
Returns TransientSnapshotChanged
See
TransientTakeSnapshotTrait
Implementation of WritableSignalTrait.takeSnapshot
Inherited from Signal.takeSnapshot
- Defined in src/transients/core/signal/signal.ts:50

throw

throw(error: unknown): void
Parameters
- error: unknown
Returns void
See
WritableSignalThrowTrait
Implementation of WritableSignalTrait.throw
- Defined in src/transients/core/writable-signal/writable-signal.ts:64

trackActivity

trackActivity(onActivity: TransientActivity): UndoFunction
Parameters
- onActivity: TransientActivity
Returns UndoFunction
See
TransientTrackActivityTrait
Implementation of WritableSignalTrait.trackActivity
Overrides Signal.trackActivity
- Defined in src/transients/core/writable-signal/writable-signal.ts:45

update

update(updateFunction: SignalUpdateFunctionCallback<GValue>): void
Parameters
- updateFunction: SignalUpdateFunctionCallback<GValue>
Returns void
See
WritableSignalUpdateTrait
Implementation of WritableSignalTrait.update
- Defined in src/transients/core/writable-signal/writable-signal.ts:71

`Static`isInContext

isInContext(): boolean
Returns true if we are currently inside a "Transient context".

Returns boolean
Inherited from Signal.isInContext
- Defined in src/transients/core/transient/transient.ts:39

`Static`runInContext

runInContext<GReturn>(
captureTransient: undefined | CaptureTransient,
callback: () => GReturn,
): GReturn
Runs a callback in witch any Transient captured synchronously through transient.capture() is provided to the function captureTransient.
Type Parameters
- GReturn
Parameters
- captureTransient: undefined | CaptureTransient
- callback: () => GReturn
Returns GReturn
Inherited from Signal.runInContext
- Defined in src/transients/core/transient/transient.ts:16

`Static`runOutsideContext

runOutsideContext<GReturn>(callback: () => GReturn): GReturn
Ignores any transient.capture() present in the context of callback.
Type Parameters
- GReturn
Parameters
- callback: () => GReturn
Returns GReturn
Inherited from Signal.runOutsideContext
- Defined in src/transients/core/transient/transient.ts:32

`Static`thrown

thrown<GValue>(
error: unknown,
options?: SignalOptions<GValue>,
): WritableSignal<GValue>
Type Parameters
- GValue
Parameters
- error: unknown
- Optionaloptions: SignalOptions<GValue>
Returns WritableSignal<GValue>
- Defined in src/transients/core/writable-signal/writable-signal.ts:22

`Static`unset

unset<GValue>(options?: SignalOptions<GValue>): WritableSignal<GValue>
Type Parameters
- GValue
Parameters
- Optionaloptions: SignalOptions<GValue>
Returns WritableSignal<GValue>
- Defined in src/transients/core/writable-signal/writable-signal.ts:18

Class WritableSignal<GValue>

See

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WritableSignal<GValue>

Methods

asReadonly

Returns ReadonlySignal<GValue>

See

capture

Returns void

See

get

Returns GValue

See

set

Parameters

Returns void

See

takeSnapshot

Returns TransientSnapshotChanged

See

throw

Parameters

Returns void

See

trackActivity

Parameters

Returns UndoFunction

See

update

Parameters

Returns void

See

StaticisInContext

Returns boolean

StaticrunInContext

Type Parameters

Parameters

Returns GReturn

StaticrunOutsideContext

Type Parameters

Parameters

Returns GReturn

Staticthrown

Type Parameters

Parameters

Returns WritableSignal<GValue>

Staticunset

Type Parameters

Parameters

Returns WritableSignal<GValue>

Settings

On This Page

`Static`isInContext

`Static`runInContext

`Static`runOutsideContext

`Static`thrown

`Static`unset