Class Signal<GValue>`Abstract`

See

SignalTrait

Type Parameters

GValue

Hierarchy (View Summary)

Transient
- Signal

Implements

SignalTrait<GValue>

Index

Constructors

Methods

capture get takeSnapshot trackActivity isInContext runInContext runOutsideContext

Constructors

constructor

new Signal<GValue>(
    initialValue: SignalValueOrError<GValue>,
    setupSignalValue: SetupSignalValue<GValue>,
    __namedParameters?: SignalOptions<GValue>,
): Signal<GValue>
Type Parameters
- GValue
Parameters
- initialValue: SignalValueOrError<GValue>
- setupSignalValue: SetupSignalValue<GValue>
- __namedParameters: SignalOptions<GValue> = {}
Returns Signal<GValue>
Overrides Transient.constructor
- Defined in src/transients/core/signal/signal.ts:21

Methods

capture

capture(): void
Returns void
See
TransientCaptureTrait
Implementation of SignalTrait.capture
Overrides Transient.capture
- Defined in src/transients/core/signal/signal.ts:62

get

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

takeSnapshot

takeSnapshot(): TransientSnapshotChanged
Returns TransientSnapshotChanged
See
TransientTakeSnapshotTrait
Implementation of SignalTrait.takeSnapshot
Overrides Transient.takeSnapshot
- Defined in src/transients/core/signal/signal.ts:50

`Abstract`trackActivity

trackActivity(onActivity: TransientActivity): UndoFunction
Parameters
- onActivity: TransientActivity
Returns UndoFunction
See
TransientTrackActivityTrait
Implementation of SignalTrait.trackActivity
Inherited from Transient.trackActivity
- Defined in src/transients/core/transient/transient.ts:51

`Static`isInContext

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

Returns boolean
Inherited from Transient.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 Transient.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 Transient.runOutsideContext
- Defined in src/transients/core/transient/transient.ts:32