Interface ReadonlyExecutor<Value>

Provides access execution results and allows to subscribe to an execution state changes.

interface ReadonlyExecutor<Value> {
    annotations: ExecutorAnnotations;
    invalidatedAt: number;
    isActive: boolean;
    isFulfilled: boolean;
    isInvalidated: boolean;
    isPending: boolean;
    isRejected: boolean;
    isSettled: boolean;
    key: any;
    manager: ExecutorManager;
    pendingPromise: null | AbortablePromise<Value>;
    reason: any;
    settledAt: number;
    task: null | ExecutorTask<Value>;
    value: undefined | Value;
    version: number;
    get(): Value;
    getOrAwait(): AbortablePromise<Value>;
    getOrDefault(): undefined | Value;
    getOrDefault<DefaultValue>(defaultValue: DefaultValue): Value | DefaultValue;
    subscribe(listener: ((value: ExecutorEvent<Value>) => void)): (() => void);
    toJSON(): ExecutorState<Value>;
}

Type Parameters

Value = any
The value stored by the executor.

Hierarchy (view full)

ExecutorState<Value>
Observable<ExecutorEvent<Value>>
- ReadonlyExecutor
  - Executor

Index

Properties

`Readonly`annotations

annotations: ExecutorAnnotations

The map of annotations associated with the executor.

`Readonly`invalidatedAt

invalidatedAt: number

The timestamp when the executor was invalidated, or 0 if the executor isn't invalidated.

`Readonly`isActive

isActive: boolean

true if the executor was activated more times then deactivated.

`Readonly`isFulfilled

isFulfilled: boolean

true if the executor was fulfilled with a value, or false otherwise.

`Readonly`isInvalidated

isInvalidated: boolean

true if invalidate was called on a settled executor and a new settlement hasn't occurred yet.

`Readonly`isPending

isPending: boolean

true if the execution is currently pending, or false otherwise.

`Readonly`isRejected

isRejected: boolean

true if the executor was rejected with a reason, or false otherwise.

`Readonly`isSettled

isSettled: boolean

true if the executor is fulfilled or rejected, or false otherwise.

`Readonly`key

key: any

The key of this executor, unique in scope of the Executor.manager.

`Readonly`manager

manager: ExecutorManager

The manager that created the executor.

`Readonly`pendingPromise

pendingPromise: null | AbortablePromise<Value>

The promise of the pending task execution, or null if there's no pending task execution.

Note: This promise is aborted if the task is replaced. Use getOrAwait to wait until the executor becomes settled.

`Readonly`reason

reason: any

The reason of the latest failure.

Note: An executor may still have a rejection reason even if it was fulfilled. Check isRejected to ensure that an executor is actually rejected.

`Readonly`settledAt

settledAt: number

The timestamp when the executor was settled, or 0 if it isn't settled.

`Readonly`task

task: null | ExecutorTask<Value>

The latest task that was executed, or null if the executor didn't execute any tasks.

`Readonly`value

value: undefined | Value

The value of the latest fulfillment.

Note: An executor may still have value even if it was rejected. Use get, getOrDefault, or getOrAwait to retrieve a value of the fulfilled executor.

`Readonly`version

version: number

The integer version of the state of this executor that is incremented every time the executor is mutated.

Methods

get

get(): Value
Returns a value if the executor is fulfilled. Throws a reason if the executor is rejected. Otherwise, throws an Error.

Returns Value

getOrAwait

getOrAwait(): AbortablePromise<Value>
Waits for the executor to become settled and non-pending. Then, the returned promise is resolved with a value if the executor is fulfilled, or rejected with a reason if the executor is rejected.

If the executor is detached during this operation, then the returned promise is rejected with the AbortError.

Returns AbortablePromise<Value>

getOrDefault

getOrDefault(): undefined | Value
Returns a value if the executor is fulfilled. Otherwise, returns undefined.

Returns undefined | Value
getOrDefault<DefaultValue>(defaultValue): Value | DefaultValue
Returns a value if the executor is fulfilled. Otherwise, returns the default value.
Type Parameters
- DefaultValue
  The default value.
Parameters
- defaultValue: DefaultValue
  The default value.
Returns Value | DefaultValue

subscribe(listener): (() => void)
Subscribes the listener to changes of the observed value.
Parameters
- listener: ((value: ExecutorEvent<Value>) => void)
  The listener to subscribe.
  - - (value): void
    - Parameters
      value: ExecutorEvent<Value>
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Inherited from Observable.subscribe

toJSON

toJSON(): ExecutorState<Value>
Returns the serializable executor state.

Returns ExecutorState<Value>

Interface ReadonlyExecutor<Value>

Type Parameters

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonlyannotations

ReadonlyinvalidatedAt

ReadonlyisActive

ReadonlyisFulfilled

ReadonlyisInvalidated

ReadonlyisPending

ReadonlyisRejected

ReadonlyisSettled

Readonlykey

Readonlymanager

ReadonlypendingPromise

Readonlyreason

ReadonlysettledAt

Readonlytask

Readonlyvalue

Readonlyversion

Methods

get

Returns Value

getOrAwait

Returns AbortablePromise<Value>

getOrDefault

Returns undefined | Value

Type Parameters

Parameters

Returns Value | DefaultValue

subscribe

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

toJSON

Returns ExecutorState<Value>

Settings

On This Page

`Readonly`annotations

`Readonly`invalidatedAt

`Readonly`isActive

`Readonly`isFulfilled

`Readonly`isInvalidated

`Readonly`isPending

`Readonly`isRejected

`Readonly`isSettled

`Readonly`key

`Readonly`manager

`Readonly`pendingPromise

`Readonly`reason

`Readonly`settledAt

`Readonly`task

`Readonly`value

`Readonly`version