Class AsyncOp<T, E>

Type you may use to check on the results of an asynchronous operation. Contains uninitialized data until AsyncOp.isComplete returns true.

Type Parameters

T
Type of the return value. Caller must ensure to provide the valid type.
E = void

Hierarchy

FrameworkObject
- AsyncOp

Implements

Promise<T>

Index

Properties

Accessors

error identifier isComplete isFailed isPending value

Methods

blockUntilComplete catch fail finally isEqual then

Properties

`Readonly`[toStringTag]

[toStringTag]: string

Accessors

error

get error(): E
Retrieves the error returned by the async operation. Only valid if AsyncOpBase.isError returns true.

Returns E
Return error of the async operation.

identifier

get identifier(): object
An opaque identifier that uniquely identifies this AsyncOp on the system. The returned is not specified, but guaranteed to be the same during runtime.

Returns object

isComplete

get isComplete(): boolean
Returns true if the async operation has completed.

Returns boolean

isFailed

get isFailed(): boolean
Returns true if the async operation has failed.

Returns boolean

isPending

get isPending(): boolean
Returns true if the async operation is pending completion or failure.

Returns boolean

value

get value(): T
Retrieves the value returned by the async operation. Only valid if AsyncOpBase.isComplete returns true.

Returns T
Return value of the async operation.

Methods

blockUntilComplete

blockUntilComplete(): AsyncOp<T, E>
Blocks the caller thread until the AsyncOp completes or fails.

Returns AsyncOp<T, E>

catch

catch(onError): this
Attaches a failure handler to the async op.
Parameters
- onError: ((error: E) => void)
  The callback to be called as continuation.
  - - (error): void
    - Parameters
      error: E
      Returns void
Returns this
this

Implementation of Promise.catch

fail

fail(onError): this
Attaches a failure handler to the async op.
Parameters
- onError: ((error: E) => void)
  The callback to be called as continuation.
  - - (error): void
    - Parameters
      error: E
      Returns void
Returns this
this

finally

finally(onFinally?): this
Attaches a finalization handler to the async op.
Parameters
- OptionalonFinally: (() => void)
  The callback to be called in case of success or failure.
  - - (): void
    - Returns void
Returns this
this

Implementation of Promise.finally

isEqual

isEqual(identifier): boolean
Determines if this async op matches the specified identifier.
Parameters
- identifier: object
Returns boolean

then

then(onComplete, onError): this
Attaches a continuation to the async op.
Parameters
- onComplete: ((result: T) => void)
  The callback to be called as continuation.
  - - (result): void
    - Parameters
      result: T
      Returns void
- onError: ((error: E) => void)
  The callback to be called as error continuation.
  - - (error): void
    - Parameters
      error: E
      Returns void
Returns this
this

Implementation of Promise.then
then(onComplete): this
Attaches a continuation to the async op.
Parameters
- onComplete: ((result: T, error?: E, identifier?: object) => void)
  The callback to be called as continuation.
  - - (result, error?, identifier?): void
    - Parameters
      result: T
      Optionalerror: E
      Optionalidentifier: object
      Returns void
Returns this
this

Implementation of Promise.then