Class Future<T, E>

Represents a Future, which is a subclass of Promise.

Type Parameters

T
The type of the resolved value.
E extends Error = Error
The type of the rejected error.

Hierarchy

Promise<T>
- Future

Index

Constructors

constructor

new Future<T, E>(executor): Future<T, E>
Creates a new Future instance.
Type Parameters
- T
- E extends Error = Error
Parameters
- executor: ((resolve, reject) => void)
  A function that is called immediately with the resolve and reject functions.
  - - (resolve, reject): void
    - Parameters
      resolve: ((value) => void)
      (value): void
      Parameters
      value: T
      Returns void
      reject: ((error) => void)
      (error): void
      Parameters
      error: E
      Returns void
      Returns void
Returns Future<T, E>
Overrides Promise<T>.constructor
- Defined in src/future.ts:18

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Protected` state

state: "Pending" | "Fulfilled" | "Rejected"

`Static` `Readonly` [species]

[species]: PromiseConstructor

Methods

catch

catch<TResult>(onrejected?): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.
Inherited from Promise.catch
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1557

finally

finally(onfinally?): Promise<T>
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.
Inherited from Promise.finally
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2018.promise.d.ts:29

isFulfilled

isFulfilled(): boolean
Checks if the Future is in the fulfilled state.

Returns boolean
True if the Future is fulfilled, false otherwise.
- Defined in src/future.ts:99

isPending

isPending(): boolean
Checks if the Future is in the pending state.

Returns boolean
True if the Future is pending, false otherwise.
- Defined in src/future.ts:91

isRejected

isRejected(): boolean
Checks if the Future is in the rejected state.

Returns boolean
True if the Future is rejected, false otherwise.
- Defined in src/future.ts:107

result

result(): Promise<Result<T, E>>
Asynchronously retrieves the result of the future.

Returns Promise<Result<T, E>>
A promise that resolves to a Result object containing either the value or the error.
- Defined in src/future.ts:48

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
  The callback to execute when the Promise is resolved.
- Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from Promise.then
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1550

`Static` all

all<T>(values): Promise<Awaited<T>[]>
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<Awaited<T>[]>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.iterable.d.ts:225
all<T>(values): Promise<{
-readonly [P in string | number | symbol]: Awaited<T[P<P>]>
}>
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 extends readonly unknown[] | []
Parameters
- values: T
  An array of Promises.
Returns Promise<{
-readonly [P in string | number | symbol]: Awaited<T[P<P>]>
}>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static` allSettled

allSettled<T>(values): Promise<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
}>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
  An array of Promises.
Returns Promise<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
}>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2020.promise.d.ts:38
allSettled<T>(values): Promise<PromiseSettledResult<Awaited<T>>[]>
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 | PromiseLike<T>>
  An array of Promises.
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2020.promise.d.ts:46

`Static` any

any<T>(values): Promise<Awaited<T[number]>>
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 extends readonly unknown[] | []
Parameters
- values: T
  An array or iterable of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2021.promise.d.ts:40
any<T>(values): Promise<Awaited<T>>
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: Iterable<T | PromiseLike<T>>
  An array or iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2021.promise.d.ts:47

`Static` err

err<T, E>(error): Future<T, E>
Creates a Future that rejects with the given error.
Type Parameters
- T
- E extends Error = Error
Parameters
- error: string | E
  The error to reject with.
Returns Future<T, E>
A new Future instance.
- Defined in src/future.ts:69

`Static` from

from<T, E>(promise): Future<T, E>
Creates a Future from an existing Promise.
Type Parameters
- T
- E extends Error = Error
Parameters
- promise: Promise<T> | PromiseComposer<T>
  The Promise to create the Future from.
Returns Future<T, E>
A new Future instance.
- Defined in src/future.ts:78

`Static` ok

ok<T, E>(value): Future<T, E>
Creates a Future that resolves with the given value.
Type Parameters
- T
- E extends Error = Error
Parameters
- value: T
  The value to resolve with.
Returns Future<T, E>
A new Future instance.
- Defined in src/future.ts:60

`Static` race

race<T>(values): Promise<Awaited<T>>
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<Awaited<T>>
A new Promise.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.iterable.d.ts:233
race<T>(values): Promise<Awaited<T[number]>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
  An array of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.promise.d.ts:50

`Static` reject

reject<T>(reason?): Promise<T>
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.
Inherited from Promise.reject
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.promise.d.ts:60

`Static` resolve

resolve(): Promise<void>
Creates a new resolved promise.

Returns Promise<void>
A resolved promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.promise.d.ts:66
resolve<T>(value): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.promise.d.ts:72
resolve<T>(value): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T | PromiseLike<T>
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.promise.d.ts:78

Class Future<T, E>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Parameters

Parameters

Returns void

Parameters

Returns void

Returns void

Returns Future<T, E>

Properties

Readonly [toStringTag]

Protected state

Static Readonly [species]

Methods

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

finally

Parameters

Returns Promise<T>

isFulfilled

Returns boolean

isPending

Returns boolean

isRejected

Returns boolean

result

Returns Promise<Result<T, E>>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Static all

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]>}>

Static allSettled

Type Parameters

Parameters

Returns Promise<{ -readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>}>

Type Parameters

Parameters

Returns Promise<PromiseSettledResult<Awaited<T>>[]>

Static any

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Static err

Type Parameters

Parameters

Returns Future<T, E>

Static from

Type Parameters

Parameters

Returns Future<T, E>

Static ok

Type Parameters

Parameters

Returns Future<T, E>

Static race

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

`Readonly` [toStringTag]

`Protected` state

`Static` `Readonly` [species]

`Static` all

Returns Promise<{
-readonly [P in string | number | symbol]: Awaited<T[P<P>]>
}>

`Static` allSettled

Returns Promise<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
}>

`Static` any

`Static` err

`Static` from

`Static` ok

`Static` race

`Static` reject

`Static` resolve