Interface PollingSignalTrait<GValue>

A Signal whose value is frequently polled from a read function.

interface PollingSignalTrait<GValue> {
    capture(): void;
    get(): GValue;
    takeSnapshot(): TransientSnapshotChanged;
    trackActivity(onActivity: TransientActivity): UndoFunction;
}

Type Parameters

GValue

Hierarchy (View Summary)

SignalTrait<GValue>
- PollingSignalTrait

Implemented by

PollingSignal

Index

Methods

capture get takeSnapshot trackActivity

Methods

capture

capture(): void
Returns void
Inherited from SignalTrait.capture
- Defined in src/transients/core/transient/traits/methods/transient.capture.trait.ts:5

get

get(): GValue
Returns GValue
Inherited from SignalTrait.get
- Defined in src/transients/core/signal/traits/methods/signal.get.trait.ts:7

takeSnapshot

takeSnapshot(): TransientSnapshotChanged
Returns TransientSnapshotChanged
Inherited from SignalTrait.takeSnapshot
- Defined in src/transients/core/transient/traits/methods/transient.take-snapshot.trait.ts:7

trackActivity

trackActivity(onActivity: TransientActivity): UndoFunction
Parameters
- onActivity: TransientActivity
Returns UndoFunction
Inherited from SignalTrait.trackActivity
- Defined in src/transients/core/transient/traits/methods/transient.track-activity.trait.ts:10