Class default<T>

The AsyncWrapper is provided to monitor the state of a promise. You can use this to provide state feedback to the user of an awaitable method.

Type Parameters

T

Hierarchy

default

Index

Constructors

Properties

#awaitable #callback #complete #completeEvent #error #promise? #promiseOrValueOrFactory #success #value

Accessors

complete completeEvent error promise success value

Methods

Constructors

constructor

new default<T>(): default<T>
Creates a new unresolved AsyncWrapper
Type Parameters
- T
Returns default<T>
- Defined in src/Promises/AsyncWrapper.ts:27
new default<T>(promiseOrValue): default<T>
Creates a new AsyncWrapper
Type Parameters
- T
Parameters
- promiseOrValue: Awaitable<T>
  can be a promise or a value
Returns default<T>
- Defined in src/Promises/AsyncWrapper.ts:32
new default<T>(promiseOrValue, callback): default<T>
Creates a new AsyncWrapper
Type Parameters
- T
Parameters
- promiseOrValue: Awaitable<T>
  can be a promise or a value
- callback: ((asyncWrapper) => void)
  the callback that should be applied after the promise is resolved
  - - (asyncWrapper): void
    - Parameters
      asyncWrapper: default<T>
      Returns void
Returns default<T>
- Defined in src/Promises/AsyncWrapper.ts:38
new default<T>(promiseFactory): default<T>
Creates a new AsyncWrapper
Type Parameters
- T
Parameters
- promiseFactory: (() => Awaitable<T>)
  can be a promise or a value factory that will be invoked immediately
  - - (): Awaitable<T>
    - Returns Awaitable<T>
Returns default<T>
- Defined in src/Promises/AsyncWrapper.ts:43
new default<T>(promiseFactory, callback): default<T>
Creates a new AsyncWrapper
Type Parameters
- T
Parameters
- promiseFactory: (() => Awaitable<T>)
  can be a promise or a value factory that will be invoked immediately
  - - (): Awaitable<T>
    - Returns Awaitable<T>
- callback: ((asyncWrapper) => void)
  the callback that should be applied after the promise is resolved
  - - (asyncWrapper): void
    - Parameters
      asyncWrapper: default<T>
      Returns void
Returns default<T>
- Defined in src/Promises/AsyncWrapper.ts:49
new default<T>(promiseOrValueOrFactory?, callback?): default<T>
Creates a new AsyncWrapper
Type Parameters
- T
Parameters
- Optional promiseOrValueOrFactory: Awaitable<T> | (() => Awaitable<T>)
  can be a promise or a value factory, a value or a promise that will be invoked immediately
- Optional callback: ((asyncWrapper) => void)
  the callback that should be applied after the promise is resolved
  - - (asyncWrapper): void
    - Parameters
      asyncWrapper: default<T>
      Returns void
Returns default<T>
- Defined in src/Promises/AsyncWrapper.ts:55

Properties

`Private` #awaitable

#awaitable: Promise<unknown>

`Private` `Readonly` #callback

#callback: undefined | ((asyncWrapper) => void)

Type declaration

- (asyncWrapper): void
- Parameters
  - asyncWrapper: default<T>
  Returns void

`Private` #complete

#complete: boolean

`Private` `Readonly` #completeEvent

#completeEvent: default<Undefinable<T>>

`Private` #error

#error: unknown

`Private` `Optional` #promise

#promise?: Promise<T>

`Private` #promiseOrValueOrFactory

#promiseOrValueOrFactory: undefined | Awaitable<T> | (() => Awaitable<T>)

Type declaration

- (): Awaitable<T>
- Returns Awaitable<T>

`Private` #success

#success: boolean

`Private` #value

#value: Undefinable<T>

Accessors

complete

get complete(): boolean
returns true when the promise is complete, even if it errored

Returns boolean
- Defined in src/Promises/AsyncWrapper.ts:144

completeEvent

get completeEvent(): default<Undefinable<T>>
Event to be fired when the internal promise has completed

Returns default<Undefinable<T>>
- Defined in src/Promises/AsyncWrapper.ts:132

error

get error(): unknown
returns the error if the promise failed

Returns unknown
- Defined in src/Promises/AsyncWrapper.ts:162

promise

get promise(): Promise<T>
Return the internal promise that is waiting for the orginal one to complete

Returns Promise<T>
- Defined in src/Promises/AsyncWrapper.ts:138

success

get success(): boolean
returns true if the promise completed successfully

Returns boolean
- Defined in src/Promises/AsyncWrapper.ts:150

value

get value(): Undefinable<T>
returns the value of the promise

Returns Undefinable<T>
- Defined in src/Promises/AsyncWrapper.ts:156

Methods

cancel

cancel(): void
Returns void
- Defined in src/Promises/AsyncWrapper.ts:167

update

update(promiseOrValueOrFactory?): void
Parameters
- promiseOrValueOrFactory: undefined | Awaitable<T> | (() => Awaitable<T>) = ...
Returns void
- Defined in src/Promises/AsyncWrapper.ts:67

Generated using TypeDoc