Class HsPromise<T>

HsPromise is a custom implementation of a promise-like object. It provides methods for handling asynchronous operations, including then, catch, and finally.

Type Parameters

Hierarchy (View Summary)

HsPromise
- PortPromise

Index

Constructors

constructor

Methods

catch finally reject resolve then all allSettled any race reject resolve withResolvers

Constructors

constructor

new HsPromise<T>(
    executor?: (
        resolve: (value?: T) => void,
        reject: (reason?: any) => void,
    ) => void,
): HsPromise<T>
Creates a new HsPromise instance.
Type Parameters
- T
Parameters
- Optionalexecutor: (resolve: (value?: T) => void, reject: (reason?: any) => void) => void
  A function that is executed immediately, with resolve and reject callbacks.
Returns HsPromise<T>

Methods

catch

catch(onRejected?: (reason: any) => T | HsPromise<T>): HsPromise<T>
Attaches a callback for when the promise is rejected.
Parameters
- OptionalonRejected: (reason: any) => T | HsPromise<T>
  A callback to execute when the promise is rejected.
Returns HsPromise<T>
A new HsPromise that resolves or rejects based on the provided callback.

finally

finally(callback: () => void): HsPromise<T>
Attaches a callback that is executed when the promise is settled, regardless of its outcome.
Parameters
- callback: () => void
  A callback to execute when the promise is settled.
Returns HsPromise<T>
A new HsPromise that resolves or rejects based on the original promise.

reject

reject(reason?: any): void
Rejects the promise with the specified reason.
Parameters
- Optionalreason: any
  The reason for rejecting the promise.
Returns void

resolve

resolve(value?: T): void
Resolves the promise with the specified value.
Parameters
- Optionalvalue: T
  The value to resolve the promise with.
Returns void

then

then<TResult>(
onFulfilled?: (value: T) => TResult | HsPromise<TResult>,
onRejected?: (reason: any) => TResult | HsPromise<TResult>,
): HsPromise<TResult>
Attaches callbacks for the fulfillment and rejection of the promise.
Type Parameters
- TResult
Parameters
- OptionalonFulfilled: (value: T) => TResult | HsPromise<TResult>
  A callback to execute when the promise is fulfilled.
- OptionalonRejected: (reason: any) => TResult | HsPromise<TResult>
  A callback to execute when the promise is rejected.
Returns HsPromise<TResult>
A new HsPromise that resolves or rejects based on the provided callbacks.

`Static`all

all<T extends readonly unknown[]>(
    values: T,
): HsPromise<
    { -readonly [P in string
    | number
    | symbol]: Awaited<T[P<P>]> },
>
Returns a promise that fulfills with an array of results when all input promises fulfill. Rejects if any one rejects.
Type Parameters
- T extends readonly unknown[]
Parameters
- values: T
  An iterable (array) of promises or values.
Returns HsPromise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]> }>
A promise that resolves with an array of results, or rejects if any input rejects.

`Static`allSettled

allSettled<T extends readonly unknown[]>(
values: T,
): HsPromise<PromiseSettledResult<Awaited<T[number]>>[]>
Returns a promise that fulfills with an array of objects describing the outcome of each input promise, regardless of whether they fulfilled or rejected.
Type Parameters
- T extends readonly unknown[]
Parameters
- values: T
  An iterable (array) of promises or values.
Returns HsPromise<PromiseSettledResult<Awaited<T[number]>>[]>
A promise that always resolves with an array of settlement results.

`Static`any

any<T extends readonly unknown[]>(values: T): HsPromise<Awaited<T[number]>>
Returns a promise that fulfills with the first fulfilled input promise. Rejects with an AggregateError if all promises reject (or if the array is empty).
Type Parameters
- T extends readonly unknown[]
Parameters
- values: T
  An iterable (array) of promises or values.
Returns HsPromise<Awaited<T[number]>>
A promise that resolves with the first fulfilled value, or rejects if all reject.

`Static`race

race<T extends readonly unknown[]>(values: T): HsPromise<Awaited<T[number]>>
Returns a promise that settles (fulfills or rejects) as soon as the first input promise settles.
Type Parameters
- T extends readonly unknown[]
Parameters
- values: T
  An iterable (array) of promises or values.
Returns HsPromise<Awaited<T[number]>>
A promise that settles with the first settled input promise.

`Static`reject

reject<T = never>(reason?: any): HsPromise<T>
Returns a promise that is rejected with the given reason.
Type Parameters
- T = never
Parameters
- Optionalreason: any
  The reason for rejecting the promise.
Returns HsPromise<T>
A promise rejected with the given reason.

`Static`resolve

resolve<T>(value?: T | HsPromise<T>): HsPromise<T>
Returns a promise that is fulfilled with the given value. If the value is already an HsPromise, it is returned directly.
Type Parameters
- T
Parameters
- Optionalvalue: T | HsPromise<T>
  The value to resolve the promise with, or an existing HsPromise.
Returns HsPromise<T>
A promise resolved with the given value.

`Static`withResolvers

withResolvers<T>(): {
    promise: HsPromise<T>;
    reject: (reason?: any) => void;
    resolve: (value: T) => void;
}
Returns an object with a promise and its resolve/reject functions. This method is not supported in HsPromise.
Type Parameters
- T
Returns {
    promise: HsPromise<T>;
    reject: (reason?: any) => void;
    resolve: (value: T) => void;
}
Throws
Error indicating that withResolvers is not supported.

Class HsPromise<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HsPromise<T>

Methods

catch

Parameters

Returns HsPromise<T>

finally

Parameters

Returns HsPromise<T>

reject

Parameters

Returns void

resolve

Parameters

Returns void

then

Type Parameters

Parameters

Returns HsPromise<TResult>

Staticall

Type Parameters

Parameters

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

StaticallSettled

Type Parameters

Parameters

Returns HsPromise<PromiseSettledResult<Awaited<T[number]>>[]>

Staticany

Type Parameters

Parameters

Returns HsPromise<Awaited<T[number]>>

Staticrace

Type Parameters

Parameters

Returns HsPromise<Awaited<T[number]>>

Staticreject

Type Parameters

Parameters

Returns HsPromise<T>

Staticresolve

Type Parameters

Parameters

Returns HsPromise<T>

StaticwithResolvers

Type Parameters

Returns { promise: HsPromise<T>; reject: (reason?: any) => void; resolve: (value: T) => void;}

Throws

Settings

On This Page

`Static`all

`Static`allSettled

`Static`any

`Static`race

`Static`reject

`Static`resolve

`Static`withResolvers

Returns {
promise: HsPromise<T>;
reject: (reason?: any) => void;
resolve: (value: T) => void;
}