Future | Retirement Simulator

A Future is a variant of a Promise that takes a function to start execution at a later point, when the value is desired. It can be used to delay a computation, or to avoid it entirely if not needed.

By default, the computation begins when the first onfulfilled handler is added with then, but if the delay parameter is supplied as true an explicit call to the eval method is required.

This can be used to delay initiating a computation until a certain elapsed time (using delay) or until some event has occurred.

Type parameters

Hierarchy

Promise<T>
- Future

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Future<T>(fn: () => T, delay?: boolean): Future<T>

Overrides Promise<T>.constructor
- Defined in git+https://github.com/BobKerns/genutils:27
Construct a Future.

The supplied fn argument will be discarded once run, so any data referenced by it can be freed by the GC.

Type parameters
- T
Parameters
- fn: () => T
 
 The function performing the future calculation
 - - (): T
 - Returns T
- Optional delay: boolean
 
 true if the calculation should be delayed until an explicit call to eval.
Returns Future<T>

Properties

Private #private

#private: any

Readonly [toStringTag]

[toStringTag]: string

Static [species]

[species]: PromiseConstructor

Static [toStringTag]

[toStringTag]: string

Methods

catch

catch<TResult>(onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>)): Promise<T | TResult>

Inherited from Promise.catch
- Defined in git+https://github.com/Microsoft/TypeScript:1460
Attaches a callback for only the rejection of the Promise.

Type parameters
- TResult = never
Parameters
- Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
 
 The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>

A Promise for the completion of the callback.

eval

eval<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): T

- Defined in git+https://github.com/BobKerns/genutils:39
Perform the calculation supplied on construction. Takes arguments like {@link Promise#then}. Any pending handlers from Promise.then(), Promise.catch(), or Promise.finally() will be also be handled as normal.

eval is run synchronously if the supplied function is synchronous. The result is not wrapped in a Promise, but will be a Promise if that's what the supplied function returns. The supplied handlers are not run synchronously.

Type parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns T

finally

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

Inherited from Promise.finally
- Defined in git+https://github.com/Microsoft/TypeScript: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.

then

then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>

Overrides Promise.then
- Defined in git+https://github.com/BobKerns/genutils:48
This runs {@link Promise#then} normally. If the supplied future function has not been run, runs that first, unless delay was supplied as truthy, or unless neither onfullfilled or onrejected was supplied.

Type parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns Promise<TResult1 | TResult2>

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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 allSettled

allSettled<T>(values: T): Promise<{-readonly [ P in string | number | symbol]-?: PromiseSettledResult<T[P] extends PromiseLike ? U : T[P]> }>
allSettled<T>(values: Iterable<T>): Promise<PromiseSettledResult<T extends PromiseLike ? U : T>[]>

Inherited from Promise.allSettled
- Defined in git+https://github.com/Microsoft/TypeScript:40
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

Type parameters
- T: readonly unknown[] | readonly [unknown]
Parameters
- values: T
 
 An array of Promises.
Returns Promise<{-readonly [ P in string | number | symbol]-?: PromiseSettledResult<T[P] extends PromiseLike ? U : T[P]> }>

A new Promise.
Inherited from Promise.allSettled
- Defined in git+https://github.com/Microsoft/TypeScript:49
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

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

A new Promise.

Static any

any<T>(values: (T | PromiseLike<T>)[] | Iterable<T | PromiseLike<T>>): Promise<T>

Inherited from Promise.any
- Defined in git+https://github.com/Microsoft/TypeScript:42
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

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

A new Promise.

Static race

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

Inherited from Promise.race
- Defined in git+https://github.com/Microsoft/TypeScript: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 : T>

A new Promise.
Inherited from Promise.race
- Defined in git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript: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 : T>

A new Promise.

Static reject

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

Inherited from Promise.reject
- Defined in git+https://github.com/Microsoft/TypeScript: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 git+https://github.com/Microsoft/TypeScript:140
Creates a new resolved promise.

Returns Promise<void>

A resolved promise.
Inherited from Promise.resolve
- Defined in git+https://github.com/Microsoft/TypeScript: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

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T

Parameters

fn: () => T

Returns T

Optional delay: boolean

Returns Future<T>

Properties

Private #private

Readonly [toStringTag]

Static [species]

Static [toStringTag]

Methods

catch

Type parameters

TResult = never

Parameters

Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

Returns Promise<T | TResult>

eval

Type parameters

TResult1 = T

TResult2 = never

Parameters

Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

Returns T

finally

Parameters

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

Returns Promise<T>

then

Type parameters

TResult1 = T

TResult2 = never

Parameters

Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

Returns Promise<TResult1 | TResult2>

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

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>]