Class Transient`Abstract`

See

TransientTrait

Hierarchy (View Summary)

Transient

Implements

TransientTrait

Index

Constructors

Methods

capture takeSnapshot trackActivity isInContext runInContext runOutsideContext

Constructors

constructor

new Transient(): Transient
Returns Transient

Methods

capture

capture(): void
Returns void
See
TransientCaptureTrait
Implementation of TransientTrait.capture
- Defined in src/transients/core/transient/transient.ts:56

`Abstract`takeSnapshot

takeSnapshot(): TransientSnapshotChanged
Returns TransientSnapshotChanged
See
TransientTakeSnapshotTrait
Implementation of TransientTrait.takeSnapshot
- Defined in src/transients/core/transient/transient.ts:46

`Abstract`trackActivity

trackActivity(onActivity: TransientActivity): UndoFunction
Parameters
- onActivity: TransientActivity
Returns UndoFunction
See
TransientTrackActivityTrait
Implementation of TransientTrait.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
- 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
- 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
- Defined in src/transients/core/transient/transient.ts:32