Class Futurable<T>

Type Parameters

Hierarchy

Promise<T>
- Futurable

Index

Constructors

constructor

new Futurable<T>(executor, signal?): Futurable<T>
Type Parameters
- T
Parameters
- executor: FuturableExecutor<T>
- Optional signal: AbortSignal
Returns Futurable<T>
Overrides Promise<T>.constructor
- Defined in index.ts:89

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Overrides Promise.[toStringTag]
- Defined in index.ts:184

signal

get signal(): AbortSignal
Return internal futurable signal

Returns AbortSignal
- Defined in index.ts:192

`Static` [species]

get [species](): typeof Futurable
Returns typeof Futurable
Overrides Promise.[species]
- Defined in index.ts:180

Methods

cancel

cancel(): void
Cancel the futurable if it is to be executed or if it is still executing.

Returns void
- Defined in index.ts:281

catch

catch<TResult2>(onRejected): Futurable<T | TResult2>
Attaches a callback for only the rejection of the Futurable.
Type Parameters
- TResult2 = never
Parameters
- onRejected: undefined | null | ((reason) => TResult2 | PromiseLike<TResult2> | FuturableLike<TResult2>)
Returns Futurable<T | TResult2>
Overrides Promise.catch
- Defined in index.ts:252

delay

delay<TResult1, TResult2>(cb, timer): Futurable<TResult1 | TResult2>
Waits for timer, then executes callback with the futurable value and returns the result obtained from the invocation.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- cb: ((val) => TResult1 | PromiseLike<TResult1> | FuturableLike<TResult1>)
  callback executed after timer with futurable chain value as parameter
  - - (val): TResult1 | PromiseLike<TResult1> | FuturableLike<TResult1>
    - Parameters
      val: T
      Returns TResult1 | PromiseLike<TResult1> | FuturableLike<TResult1>
- timer: number
  timer to wait (in milliseconds)
Returns Futurable<TResult1 | TResult2>
- Defined in index.ts:290

fetch

fetch(url, opts?): Futurable<Response>
Extension of the fetch API with cancellation support. Url parameter can be a string or a function with receive value from futurable chaining as paremeter.
Parameters
- url: string | ((val?) => string)
  url to fetch or function with futurable chaining value that returns url to fetch
- Optional opts: object | RequestInit | ((val?) => RequestInit)
  fetch options or function with futurable chaining value that return fetch options
Returns Futurable<Response>
- Defined in index.ts:323

finally

finally(onfinally): Futurable<T>
Attaches a callback that is invoked when the Futurable is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- onfinally: (() => undefined | null | void)
  - - (): undefined | null | void
    - Returns undefined | null | void
Returns Futurable<T>
Overrides Promise.finally
- Defined in index.ts:262

futurizable

futurizable<TResult1, TResult2>(promise): Futurable<TResult1 | TResult2>
Takes a promise and transforms it into a futurizable. Promise can be also a function that receives value from futurable chaining as parameter.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- promise: Promise<TResult1> | ((val?) => Promise<TResult1>)
  Promise to futurize or function that return promise with futurable chaining value as parameter
Returns Futurable<TResult1 | TResult2>
- Defined in index.ts:373

onCancel

onCancel<TResult1, TResult2>(cb): Futurable<TResult1 | TResult2>
Executes the callback passed as a parameter when the futurable is cancelled.
Type Parameters
- TResult1 = void
- TResult2 = never
Parameters
- cb: (() => void)
  - - (): void
    - Returns void
Returns Futurable<TResult1 | TResult2>
- Defined in index.ts:352

sleep

sleep(timer): Futurable<T>
Waits for timer parameter (in milliseconds) before returning the value.
Parameters
- timer: number
  timer to wait (in milliseconds)
Returns Futurable<T>
- Defined in index.ts:313

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): Futurable<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Futurable.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1> | FuturableLike<TResult1>)
- Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2> | FuturableLike<TResult2>)
Returns Futurable<TResult1 | TResult2>
Overrides Promise.then
- Defined in index.ts:208

`Static` all

all<T>(values, signal?): Futurable<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>
Creates a Futurable with cancellation support that is resolved with an array of results when all of the provided Futurables resolve, or rejected when any Futurable is rejected.
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional signal: AbortSignal
Returns Futurable<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>
Overrides Promise.all
- Defined in index.ts:520

`Static` allSettled

allSettled<T>(values, signal?): Futurable<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>
Creates a Futurable with cancellation support that is resolved with an array of results when all of the provided Futurables resolve or reject.
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional signal: AbortSignal
Returns Futurable<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>
Overrides Promise.allSettled
- Defined in index.ts:545

`Static` any

any<T>(values, signal?): Futurable<Awaited<T[number]>>
The any function returns a futurable with cancellation support that is fulfilled by the first given futurable to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given futurables are rejected. It resolves all elements of the passed iterable to futurables as it runs this algorithm.
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional signal: AbortSignal
Returns Futurable<Awaited<T[number]>>
Overrides Promise.any
- Defined in index.ts:597

`Static` delay

delay<T, TResult2>(options): Futurable<T | TResult2>
Delay static method. It accepts a object with timer and cb properties and an optional signal property.
Type Parameters
- T = any
- TResult2 = never
Parameters
- options: {
      cb: (() => T);
      signal?: AbortSignal;
      timer: number;
  }
  - cb: (() => T)
    - (): T
      Returns T
  - Optional signal?: AbortSignal
  - timer: number
Returns Futurable<T | TResult2>
- Defined in index.ts:437

`Static` fetch

fetch(url, opts?): Futurable<Response>
Fetch static method.
Parameters
- url: string
- Optional opts: RequestInit
Returns Futurable<Response>
- Defined in index.ts:462

`Static` futurizable

futurizable<TResult1, TResult2>(options): Futurable<TResult1 | TResult2>
Futurizable static method.
Type Parameters
- TResult1 = any
- TResult2 = never
Parameters
- options: {
  promise: Promise<TResult1>;
  signal?: AbortSignal;
  }
  - promise: Promise<TResult1>
  - Optional signal?: AbortSignal
Returns Futurable<TResult1 | TResult2>
- Defined in index.ts:475

`Static` onCancel

onCancel<T>(options): Futurable<T>
OnCancel static method. It accepts a callback or a object with cb property and an optional signal.
Type Parameters
- T = void
Parameters
- options: {
  cb: (() => T);
  signal?: AbortSignal;
  }
  - cb: (() => T)
    - (): T
      Returns T
  - Optional signal?: AbortSignal
Returns Futurable<T>
- Defined in index.ts:426

`Static` polling

polling<T>(fun, options): {
cancel: (() => void);
catch: ((onrejected) => void);
}
Creates a polling service with cancellation support and possibility to handle error. An optional param immediate can be set true if fun must to be invoke immediatly.
Type Parameters
- T
Parameters
- fun: (() => T | Futurable<T> | Promise<T>)
  - - (): T | Futurable<T> | Promise<T>
    - Returns T | Futurable<T> | Promise<T>
- options: {
      immediate?: boolean;
      interval: number;
      signal?: AbortSignal;
  }
  - Optional immediate?: boolean
  - interval: number
  - Optional signal?: AbortSignal
Returns {
cancel: (() => void);
catch: ((onrejected) => void);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- catch: ((onrejected) => void)
  - - (onrejected): void
    - Parameters
      onrejected: ((reason) => void)
      (reason): void
      Parameters
      reason: unknown
      Returns void
      Returns void
- Defined in index.ts:622

`Static` race

race<T>(values, signal?): Futurable<Awaited<T[number]>>
Creates a Futurable with cancellation support that is resolved or rejected when any of the provided Futurables are resolved or rejected.
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional signal: AbortSignal
Returns Futurable<Awaited<T[number]>>
Overrides Promise.race
- Defined in index.ts:569

`Static` reject

reject<T>(reason?, signal?): Futurable<T>
Creates a new rejected futurable for the provided reason.
Type Parameters
- T = never
Parameters
- Optional reason: any
- Optional signal: AbortSignal
Returns Futurable<T>
Overrides Promise.reject
- Defined in index.ts:417

`Static` resolve

resolve(): Futurable<void>
Creates a new resolved futurable. Creates a new resolved futurable for the provided value.

Returns Futurable<void>
Overrides Promise.resolve
- Defined in index.ts:393
resolve<T>(value, signal?): Futurable<T>
Type Parameters
- T = any
Parameters
- value: T | PromiseLike<T> | FuturableLike<T>
- Optional signal: AbortSignal
Returns Futurable<T>
Overrides Promise.resolve
- Defined in index.ts:399

`Static` sleep

sleep(options): Futurable<void>
Sleep static method. It accepts a timer or a object with timer property and an optional signal.
Parameters
- options: {
  signal?: AbortSignal;
  timer: number;
  }
  - Optional signal?: AbortSignal
  - timer: number
Returns Futurable<void>
- Defined in index.ts:448

`Static` withResolvers

withResolvers<T>(signal?): FuturableWithResolvers<T>
Extension of Promise.withResolvers static method. Creates a new Futurable and returns it in an object, along with its resolve, reject and cancel functions and utils object.
Type Parameters
- T
Parameters
- Optional signal: AbortSignal
Returns FuturableWithResolvers<T>
- Defined in index.ts:659

Class Futurable<T>

Type Parameters

T

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

executor: FuturableExecutor<T>

Optional signal: AbortSignal

Returns Futurable<T>

Accessors

[toStringTag]

Returns string

signal

Returns AbortSignal

Static [species]

Returns typeof Futurable

Methods

cancel

Returns void

catch

Type Parameters

TResult2 = never

Parameters

onRejected: undefined | null | ((reason) => TResult2 | PromiseLike<TResult2> | FuturableLike<TResult2>)

Returns Futurable<T | TResult2>

delay

Type Parameters

TResult1 = T

TResult2 = never

Parameters

cb: ((val) => TResult1 | PromiseLike<TResult1> | FuturableLike<TResult1>)

Parameters

val: T

Returns TResult1 | PromiseLike<TResult1> | FuturableLike<TResult1>

timer: number

Returns Futurable<TResult1 | TResult2>

fetch

Parameters

url: string | ((val?) => string)

Optional opts: object | RequestInit | ((val?) => RequestInit)

Returns Futurable<Response>

finally

Parameters

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

Returns undefined | null | void

Returns Futurable<T>

futurizable

Type Parameters

TResult1 = T

TResult2 = never

Parameters

promise: Promise<TResult1> | ((val?) => Promise<TResult1>)

Returns Futurable<TResult1 | TResult2>

onCancel

Type Parameters

TResult1 = void

TResult2 = never

Parameters

cb: (() => void)

Returns void

Returns Futurable<TResult1 | TResult2>

sleep

Parameters

timer: number

Returns Futurable<T>

then

Type Parameters

TResult1 = T

TResult2 = never

Parameters

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

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

Returns Futurable<TResult1 | TResult2>

`Optional` signal: AbortSignal

`Static` [species]

`Optional` opts: object | RequestInit | ((val?) => RequestInit)

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

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

`Static` all

`Optional` signal: AbortSignal

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

`Static` allSettled

`Optional` signal: AbortSignal

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

`Static` any

`Optional` signal: AbortSignal

`Static` delay

options: {
cb: (() => T);
signal?: AbortSignal;
timer: number;
}

`Optional` signal?: AbortSignal

`Static` fetch

`Optional` opts: RequestInit

`Static` futurizable

options: {
promise: Promise<TResult1>;
signal?: AbortSignal;
}

`Optional` signal?: AbortSignal

`Static` onCancel

options: {
cb: (() => T);
signal?: AbortSignal;
}

`Optional` signal?: AbortSignal

`Static` polling

options: {
immediate?: boolean;
interval: number;
signal?: AbortSignal;
}

`Optional` immediate?: boolean

`Optional` signal?: AbortSignal

Returns {
cancel: (() => void);
catch: ((onrejected) => void);
}