Class PromiseWithMetadata<T>

Utility object to store a single promise and associated metadata that will make handling easier.

Type Parameters

T

Hierarchy

PromiseWithMetadata

Index

Constructors

Properties

completedAt promise rejected resolved timestampedValue? value?

Methods

Constructors

`Private` constructor

new PromiseWithMetadata<T>(resolved: boolean, rejected: boolean, completedAt: number, promise: Promise<T>, value?: T): PromiseWithMetadata<T>
Creates a new Promise wrapper
Type Parameters
- T
Parameters
- resolved: boolean
  
  Was this promise resolved?
- rejected: boolean
  
  Was this promise rejected?
- completedAt: number
  
  When was this promise resolved or rejected?
- promise: Promise<T>
  
  The promise this object wraps.
- Optional value: T
  
  If the promise resolved the unwrapped value.
Returns PromiseWithMetadata<T>
- Defined in src/util/PromiseWithMetadata.ts:18

Properties

`Readonly` completedAt

completedAt: number

`Readonly` promise

promise: Promise<T>

`Readonly` rejected

rejected: boolean

`Readonly` resolved

resolved: boolean

`Optional` `Readonly` timestampedValue

timestampedValue?: TimestampedValue<T>

`Optional` `Readonly` value

value?: T

Methods

`Static` from

from<T>(arg1: Promise<T> | TimestampedValue<T>): Promise<PromiseWithMetadata<T>>
Static method to create a PromiseWithMetadata object.
Type Parameters
- T
Parameters
- arg1: Promise<T> | TimestampedValue<T>
Returns Promise<PromiseWithMetadata<T>>
- Defined in src/util/PromiseWithMetadata.ts:38

Generated using TypeDoc