Class Transaction<Arguments, Result, Status>`Abstract`

Type Parameters

Arguments extends unknown[]
Result = unknown
Status = unknown

Hierarchy (view full)

Transaction
- PreferenceTransaction

Index

Constructors

Properties

_open _result inUse onWillConcludeEmitter queue status

Accessors

onWillConclude open result

Methods

act conclude dispose disposeWhenDone doInit enqueueAction init setUp tearDown waitFor

Constructors

constructor

new Transaction<Arguments, Result, Status>(): Transaction<Arguments, Result, Status>
Type Parameters
- Arguments extends unknown[]
- Result = unknown
- Status = unknown
Returns Transaction<Arguments, Result, Status>

Properties

`Protected` _open

_open: boolean = true

`Protected` _result

_result: Deferred<false | Result> = ...

`Protected` inUse

inUse: boolean = false

Whether any actions have been added to the transaction. The Transaction will not self-dispose until at least one action has been performed.

`Protected` `Readonly` onWillConcludeEmitter

onWillConcludeEmitter: Emitter<OnWillConcludeEvent<Status>> = ...

`Protected` `Readonly` queue

queue: Mutex = ...

The transaction will self-dispose when the queue is empty, once at least one action has been processed.

`Protected` status

status: Deferred<Status> = ...

Accessors

onWillConclude

get onWillConclude(): Event<OnWillConcludeEvent<Status>>
An event fired when the transaction is wrapping up. Consumers can call waitUntil on the event to delay the resolution of the result Promise.

Returns Event<OnWillConcludeEvent<Status>>
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:62

open

get open(): boolean
Whether the transaction is still accepting new interactions. Enqueueing an action when the Transaction is no longer open will throw an error.

Returns boolean
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:43

result

get result(): Promise<false | Result>
The status of the transaction when complete.

Returns Promise<false | Result>
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:50

Methods

`Protected` `Abstract` act

act(...args): MaybePromise<Result>
Performs a single interaction
Parameters
- Rest ...args: Arguments
Returns MaybePromise<Result>
the result of that interaction, specific to a given transaction type.
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:169

`Protected` conclude

conclude(): Promise<void>
Returns Promise<void>
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:138

dispose

dispose(): void
Returns void
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:154

`Protected` disposeWhenDone

disposeWhenDone(): void
Returns void
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:126

`Protected` doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:78

enqueueAction

enqueueAction(...args): Promise<false | Result>
Parameters
- Rest ...args: Arguments
Returns Promise<false | Result>
a promise reflecting the result of performing an action. Typically the promise will not resolve until the whole transaction is complete.
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:103

`Protected` init

init(): void
Returns void
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:74

`Protected` `Abstract` setUp

setUp(): MaybePromise<Status>
Runs any code necessary to initialize the batch of interactions. No interaction will be run until the setup is complete.

Returns MaybePromise<Status>
a representation of the success of setup specific to a given transaction implementation.
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:163

`Protected` `Abstract` tearDown

tearDown(): MaybePromise<Result>
Runs any code necessary to complete a transaction and release any resources it holds.

Returns MaybePromise<Result>
implementation-specific information about the success of the transaction. Will be used as the final status of the transaction.
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:175

waitFor

waitFor(delay?, disposeIfRejected?): Promise<void>
Parameters
- Optional delay: Promise<unknown>
- Optional disposeIfRejected: boolean
Returns Promise<void>
- Defined in packages/preferences/src/browser/preference-transaction-manager.ts:90