TimedPromise

author: Barenholz D.
description: A promise that can be timed out, with typings.
version: 0.3.0

Type parameters

Hierarchy

Promise<T>
- TimedPromise

Implements

TimedPromiseInterface<T>

Index

Constructors

constructor

Properties

Accessors

settled

Methods

Constructors

constructor

new TimedPromise<T>(executor: ((resolve?: (value: T) => void, reject?: (reason?: any) => void, timeout?: number) => void) | Promise<T> | PromiseLike<T>): TimedPromise<T>

Overrides Promise<T>.constructor
- Defined in src/index.ts:71
Constructor. Creates a TimedPromise object.

Type parameters
- T
Parameters
- executor: ((resolve?: (value: T) => void, reject?: (reason?: any) => void, timeout?: number) => void) | Promise<T> | PromiseLike<T>
  
  Either a (timed)-promise, or an executor, possibly with timeout.
Returns TimedPromise<T>

Properties

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

timedPromise: TimedPromiseType

Static Readonly [Symbol.species]

[Symbol.species]: PromiseConstructor

Accessors

settled

get settled(): boolean

- Defined in src/index.ts:196
Returns boolean

whether or not this TimedPromise object is still pending.

Methods

catch

catch<TypeA>(onrejected?: null | ((reason: any, ms?: number) => TypeA | PromiseLike<TypeA>)): TimedPromise<T | TypeA>

Implementation of TimedPromiseInterface.catch

Overrides Promise.catch
- Defined in src/index.ts:230
Attaches a callback for only the rejection of the TimedPromise.

Type parameters
- TypeA = never
Parameters
- Optional onrejected: null | ((reason: any, ms?: number) => TypeA | PromiseLike<TypeA>)
  
  The callback to execute when the TimedPromise is rejected.
Returns TimedPromise<T | TypeA>

A TimedPromise for the completion of the callback.

created

created(): number

- Defined in src/index.ts:171
Returns number

time of creation of TimedPromise object.

elapsed

elapsed(): number

- Defined in src/index.ts:178
Returns number

time elapsed since creation of TimedPromise object

finally

finally(onfinally?: null | (() => void)): Promise<T>

Implementation of TimedPromiseInterface.finally

Inherited from Promise.finally
- Defined in node_modules/typescript/lib/lib.es2018.promise.d.ts:31
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Parameters
- Optional onfinally: null | (() => void)
  
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>

A Promise for the completion of the callback.

remaining

remaining(): number

- Defined in src/index.ts:185
Returns number

the time remaining before the TimedPromise object rejects.

then

then<TypeA, TypeB>(onfulfilled?: null | ((value: T, ms?: number) => TypeA | PromiseLike<TypeA>), onrejected?: null | ((reason: any, ms?: number) => TypeB | PromiseLike<TypeB>)): TimedPromise<TypeA | TypeB>

Implementation of TimedPromiseInterface.then

Overrides Promise.then
- Defined in src/index.ts:207
Attaches callbacks for the resolution and/or rejection of the TimedPromise.

Type parameters
- TypeA = T
- TypeB = never
Parameters
- Optional onfulfilled: null | ((value: T, ms?: number) => TypeA | PromiseLike<TypeA>)
  
  The callback to execute when the TimedPromise is resolved.
- Optional onrejected: null | ((reason: any, ms?: number) => TypeB | PromiseLike<TypeB>)
  
  The callback to execute when the TimedPromise is rejected.
Returns TimedPromise<TypeA | TypeB>

A TimedPromise for the completion of which ever callback is executed.

timeout

timeout(ms: number, reason?: String, catchable_by_parent?: Boolean): TimedPromise<T>

- Defined in src/index.ts:142
Allows .timeout() call on a TimedPromise object to set the timeout.

Parameters
- ms: number
  
  the timeout value in ms
- reason: String = "promise timeout"
- catchable_by_parent: Boolean = false
Returns TimedPromise<T>

this, TimedPromise instance.

Static all

all<T>(values: Iterable<T | PromiseLike<T>>): Promise<T[]>
all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>
all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>
all<T1, T2, T3, T4, T5, T6, T7, T8>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>
all<T1, T2, T3, T4, T5, T6, T7>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]): Promise<[T1, T2, T3, T4, T5, T6, T7]>
all<T1, T2, T3, T4, T5, T6>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]): Promise<[T1, T2, T3, T4, T5, T6]>
all<T1, T2, T3, T4, T5>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]): Promise<[T1, T2, T3, T4, T5]>
all<T1, T2, T3, T4>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]): Promise<[T1, T2, T3, T4]>
all<T1, T2, T3>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]): Promise<[T1, T2, T3]>
all<T1, T2>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]): Promise<[T1, T2]>
all<T>(values: readonly (T | PromiseLike<T>)[]): Promise<T[]>

Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:226
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  
  An iterable of Promises.
Returns Promise<T[]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:41
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
- T9
- T10
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:49
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
- T9
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:57
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:65
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4, T5, T6, T7]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:73
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4, T5, T6]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:81
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
- T5
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4, T5]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:89
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
- T4
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3, T4]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:97
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
- T3
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]
  
  An array of Promises.
Returns Promise<[T1, T2, T3]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:105
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T1
- T2
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]
  
  An array of Promises.
Returns Promise<[T1, T2]>

A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:113
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Type parameters
- T
Parameters
- values: readonly (T | PromiseLike<T>)[]
  
  An array of Promises.
Returns Promise<T[]>

A new Promise.

Static race

race<T>(values: Iterable<T>): Promise<T extends PromiseLike<U> ? U : T>
race<T>(values: Iterable<T | PromiseLike<T>>): Promise<T>
race<T>(values: readonly T[]): Promise<T extends PromiseLike<U> ? U : T>

Inherited from Promise.race
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:234
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Type parameters
- T
Parameters
- values: Iterable<T>
  
  An iterable of Promises.
Returns Promise<T extends PromiseLike<U> ? U : T>

A new Promise.
Inherited from Promise.race
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:242
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Type parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  
  An iterable of Promises.
Returns Promise<T>

A new Promise.
Inherited from Promise.race
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:124
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Type parameters
- T
Parameters
- values: readonly T[]
  
  An array of Promises.
Returns Promise<T extends PromiseLike<U> ? U : T>

A new Promise.

Static reject

reject<T>(reason?: any): Promise<T>

Inherited from Promise.reject
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:134
Creates a new rejected promise for the provided reason.

Type parameters
- T = never
Parameters
- Optional reason: any
  
  The reason the promise was rejected.
Returns Promise<T>

A new rejected Promise.

Static resolve

resolve(): Promise<void>
resolve<T>(value: T | PromiseLike<T>): Promise<T>

Inherited from Promise.resolve
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:140
Creates a new resolved promise.

Returns Promise<void>

A resolved promise.
Inherited from Promise.resolve
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:147
Creates a new resolved promise for the provided value.

Type parameters
- T
Parameters
- value: T | PromiseLike<T>
  
  A promise.
Returns Promise<T>

A promise whose internal state matches the provided promise.

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

T

Parameters

executor: ((resolve?: (value: T) => void, reject?: (reason?: any) => void, timeout?: number) => void) | Promise<T> | PromiseLike<T>

Returns TimedPromise<T>

Properties

Readonly [Symbol.toStringTag]

timedPromise

Static Readonly [Symbol.species]

Accessors

settled

Returns boolean

Methods

catch

Type parameters

TypeA = never

Parameters

Optional onrejected: null | ((reason: any, ms?: number) => TypeA | PromiseLike<TypeA>)

Returns TimedPromise<T | TypeA>

created

Returns number

elapsed

Returns number

finally

Parameters

Optional onfinally: null | (() => void)

Returns Promise<T>

remaining

Returns number

then

Type parameters

TypeA = T

TypeB = never

Parameters

Optional onfulfilled: null | ((value: T, ms?: number) => TypeA | PromiseLike<TypeA>)

Optional onrejected: null | ((reason: any, ms?: number) => TypeB | PromiseLike<TypeB>)

Returns TimedPromise<TypeA | TypeB>

timeout

Parameters

ms: number

reason: String = "promise timeout"

catchable_by_parent: Boolean = false

Returns TimedPromise<T>

Static all

Type parameters

T

Parameters

values: Iterable<T | PromiseLike<T>>

Returns Promise<T[]>

Type parameters

T1

T2

T3

T4

T5

T6

T7

T8

T9

T10

Parameters

values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]

Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

Type parameters

T1

T2

T3

T4

T5