Class PollingSignal<GValue>

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

Type Parameters

GValue

Hierarchy (View Summary)

Signal<GValue>
- PollingSignal

Implements

PollingSignalTrait<GValue>

Index

Constructors

constructor

Methods

capture get takeSnapshot trackActivity initIdleTrigger isInContext runInContext runOutsideContext trigger

Constructors

constructor

new PollingSignal<GValue>(
read: PollingSignalReadFunction<GValue>,
options?: PollingSignalOptions<GValue>,
): PollingSignal<GValue>
Type Parameters
- GValue
Parameters
- read: PollingSignalReadFunction<GValue>
- Optionaloptions: PollingSignalOptions<GValue>
Returns PollingSignal<GValue>
Overrides Signal.constructor
- Defined in src/transients/extension.protected/polling-signal/polling-signal.ts:46

Methods

capture

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

get

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

takeSnapshot

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

trackActivity

trackActivity(onActivity: TransientActivity): UndoFunction
Parameters
- onActivity: TransientActivity
Returns UndoFunction
See
TransientTrackActivityTrait
Implementation of PollingSignalTrait.trackActivity
Overrides Signal.trackActivity
- Defined in src/transients/extension.protected/polling-signal/polling-signal.ts:73

`Static`initIdleTrigger

initIdleTrigger(): UndoFunction
Returns UndoFunction
- Defined in src/transients/extension.protected/polling-signal/polling-signal.ts:23

`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`trigger

trigger(): void
Returns void
- Defined in src/transients/extension.protected/polling-signal/polling-signal.ts:19

Class PollingSignal<GValue>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PollingSignal<GValue>

Methods

capture

Returns void

See

get

Returns GValue

See

takeSnapshot

Returns TransientSnapshotChanged

See

trackActivity

Parameters

Returns UndoFunction

See

StaticinitIdleTrigger

Returns UndoFunction

StaticisInContext

Returns boolean

StaticrunInContext

Type Parameters

Parameters

Returns GReturn

StaticrunOutsideContext

Type Parameters

Parameters

Returns GReturn

Statictrigger

Returns void

Settings

On This Page

`Static`initIdleTrigger

`Static`isInContext

`Static`runInContext

`Static`runOutsideContext

`Static`trigger