Module Operators

A module that provides static bindings for functions implemented by ExtendedPromise.

Index

Functions

Functions

For

For<P>(ctor: BasicPromiseConstructor<P>): StaticOperators<P>

- Defined in operators.ts:21
Returns a StaticOperators module, which provides static bindings for functions implemented by a ExtendedPromiseConstructor. The StaticOperators instance provides functions that use the constructor ctor internally.

constructor

Type parameters
- P: BasicPromise<any>
Parameters
- ctor: BasicPromiseConstructor<P>
  
  The promise constructor for which to create an operators module.
Returns StaticOperators<P>

and

and<P, T>(promise: P, ...others: PromiseLike<T>[]): BasicPromise<any[]>

- Defined in operators.ts:57
Static version of the and function.

see

ExtendedPromise.and

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- Rest ...others: PromiseLike<T>[]
Returns BasicPromise<any[]>

The return type of this function is meant to be P<T[]>, where P is the input promise type.

delay

delay<P, T>(promise: P, time: number | Date): P

- Defined in operators.ts:130
Static version of the delay function.

see

ExtendedPromise.delay

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- time: number | Date
Returns P

each

each<P, T>(promise: P, action: AsyncCallback<any, void>): P

- Defined in operators.ts:145
Static version of the each function.

see

ExtendedPromise.each

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- action: AsyncCallback<any, void>
Returns P

fallback

fallback<P, T>(promise: P, ...others: (T | PromiseLike<T> | function)[]): P

- Defined in operators.ts:92
Static version of the fallback function.

see

ExtendedPromise.fallback

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- Rest ...others: (T | PromiseLike<T> | function)[]
Returns P

invert

invert<T, P>(promise: P): BasicPromise<any>

- Defined in operators.ts:276
Static version of the invert function.

see

ExtendedPromise.invert

Type parameters
- T
- P: BasicPromise<T>
Parameters
- promise: P
Returns BasicPromise<any>

The return type of this function is meant to be P<any>, where P is the promise type.

lastly

lastly<T, P>(promise: P, action: AsyncCallback<any, void>): P

- Defined in operators.ts:163
Static version of the lastly function.

see

ExtendedPromise.lastly

Type parameters
- T
- P: BasicPromise<T>
Parameters
- promise: P
- action: AsyncCallback<any, void>
Returns P

mustNot

mustNot<P, T>(promise: P, failReason: AsyncCallback<T, any>): P

- Defined in operators.ts:185
Static version of the mustNot function.

see

[[ExtendedPromise.mustNot]]

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- failReason: AsyncCallback<T, any>
Returns P

race

race<P, T>(promise: P, ...others: PromiseLike<T>[]): P

- Defined in operators.ts:29
Static version of the race function.

see

ExtendedPromise.race

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- Rest ...others: PromiseLike<T>[]
Returns P

stall

stall<P, T>(promise: P, time: number | Date): P

- Defined in operators.ts:213
Static version of the stall function.

see

ExtendedPromise.stall

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- time: number | Date
Returns P

test

test<P, T>(promise: P): BasicPromise<boolean>

- Defined in operators.ts:266
Static version of the test function.

see

ExtendedPromise.test

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
Returns BasicPromise<boolean>

The return type is meant to be P<boolean>, where P is the promise type.

timeout

timeout<P, T>(promise: P, time: number | Date, onTimeout?: function): P

- Defined in operators.ts:247
Static version of the timeout function.

see

ExtendedPromise.timeout

Type parameters
- P: BasicPromise<T>
- T
Parameters
- promise: P
- time: number | Date
- Optional onTimeout: function
  - - (): T | PromiseLike<T>
    - Returns T | PromiseLike<T>
Returns P

Generated using TypeDoc