Class default<T, TErr>

This class can spawn multiple promises and you can resolve / reject multiple ones at the same time.

Type Parameters

T
TErr = any

Index

Constructors

Accessors

pendingPromiseCount

Methods

addNewPromise rejectAll rejectFirst rejectLast resolveAll resolveFirst resolveLast

Constructors

constructor

new default<T, TErr = any>(
maxPendingPromiseCount?: number,
defaultTimeout?: number,
): default<T, TErr>
Constructor.
Type Parameters
- T
- TErr = any
Parameters
- maxPendingPromiseCount: number = Number.POSITIVE_INFINITY
  Maximum number of unresolved promises before the createPromise function throws.
- defaultTimeout: number = Number.POSITIVE_INFINITY
  The default timeout for newly created promises.
Returns default<T, TErr>
- Defined in misc/MultiPromise.ts:16

Accessors

pendingPromiseCount

get pendingPromiseCount(): number
Get the number of pending promises.

Returns number
- Defined in misc/MultiPromise.ts:27

Methods

addNewPromise

addNewPromise(timeout?: number): Promise<T>
Add a new promise.

Note that this function will throw synchronous when the number of pending promises has been exceeded (>= maxPendingPromiseCount).
Parameters
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<T>
- Defined in misc/MultiPromise.ts:40

rejectAll

rejectAll(err: TErr): boolean
Reject all promises.
Parameters
- err: TErr
  argument with which to reject the promises.
Returns boolean
- Defined in misc/MultiPromise.ts:165

rejectFirst

rejectFirst(err: TErr): boolean
Reject the promise that was added first.
Parameters
- err: TErr
  argument with which to reject the promise.
Returns boolean
- Defined in misc/MultiPromise.ts:133

rejectLast

rejectLast(err: TErr): boolean
Reject the promise that was added last.
Parameters
- err: TErr
  argument with which to reject the promise.
Returns boolean
- Defined in misc/MultiPromise.ts:101

resolveAll

resolveAll(arg: T): boolean
Resolve all promises.
Parameters
- arg: T
  argument with which to resolve the promises.
Returns boolean
- Defined in misc/MultiPromise.ts:149

resolveFirst

resolveFirst(arg: T): boolean
Resolve the promise that was added first.
Parameters
- arg: T
  argument with which to resolve the promise.
Returns boolean
- Defined in misc/MultiPromise.ts:117

resolveLast

resolveLast(arg: T): boolean
Resolve the promise that was added last.
Parameters
- arg: T
  argument with which to resolve the promise.
Returns boolean
- Defined in misc/MultiPromise.ts:85