Class APIPromise<T>

A subclass of Promise providing additional helper methods for interacting with the SDK.

Type Parameters

Hierarchy

Promise<T>
- APIPromise

Index

Constructors

constructor

new APIPromise<T>(
 client: GboxClient,
 responsePromise: Promise<APIResponseProps>,
 parseResponse?: (
 client: GboxClient,
 props: APIResponseProps,
 ) => PromiseOrValue<T>,
): APIPromise<T>
Type Parameters
- T
Parameters
- client: GboxClient
- responsePromise: Promise<APIResponseProps>
- parseResponse: (client: GboxClient, props: APIResponseProps) => PromiseOrValue<T> = defaultParseResponse
Returns APIPromise<T>
Overrides Promise<T>.constructor
- Defined in src/core/api-promise.ts:16

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Methods

_thenUnwrap

_thenUnwrap(
transform: (data: T, props: APIResponseProps) => U,
): APIPromise
Type Parameters
- U
Parameters
- transform: (data: T, props: APIResponseProps) => U
Returns APIPromise
- Defined in src/core/api-promise.ts:33

asResponse

asResponse(): Promise<Response>
Gets the raw Response instance instead of parsing the response data.

If you want to parse the response body but still get the Response instance, you can use ().

👋 Getting the wrong TypeScript type for Response? Try setting "moduleResolution": "NodeNext" or add "lib": ["DOM"] to your tsconfig.json.

Returns Promise<Response>
- Defined in src/core/api-promise.ts:50

catch

catch<TResult = never>(
onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: ((reason: any) => TResult | PromiseLike<TResult>) | null
 The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.
Overrides Promise.catch
- Defined in src/core/api-promise.ts:83

finally

finally(onfinally?: (() => void) | null): 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
- Optionalonfinally: (() => void) | null
 The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.
Overrides Promise.finally
- Defined in src/core/api-promise.ts:89

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | null
 The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
 The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Overrides Promise.then
- Defined in src/core/api-promise.ts:76

withResponse

withResponse(): Promise<{ data: T; response: Response }>
Gets the parsed response data and the raw Response instance.

If you just want to get the raw Response instance without parsing it, you can use ().

👋 Getting the wrong TypeScript type for Response? Try setting "moduleResolution": "NodeNext" or add "lib": ["DOM"] to your tsconfig.json.

Returns Promise<{ data: T; response: Response }>
- Defined in src/core/api-promise.ts:64

`Static`all

all<T>(values: Iterable<T | PromiseLike<T>>): 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/typescript/lib/lib.es2015.iterable.d.ts:255
all<T extends [] | readonly unknown[]>(
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[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]> }>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
 values: T,
): Promise<
 {
 -readonly [P in string
 | number
 | symbol]: PromiseSettledResult<Awaited<T[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]>>
 },
>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/typescript/lib/lib.es2020.promise.d.ts:38
allSettled<T>(
values: Iterable<T | PromiseLike<T>>,
): 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/typescript/lib/lib.es2020.promise.d.ts:46

`Static`race

race<T>(values: Iterable<T | PromiseLike<T>>): 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/typescript/lib/lib.es2015.iterable.d.ts:263
race<T extends [] | readonly unknown[]>(values: T): 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/typescript/lib/lib.es2015.promise.d.ts:50

`Static`reject

reject<T = never>(reason?: any): Promise<T>
Creates a new rejected promise for the provided reason.
Type Parameters
- T = never
Parameters
- Optionalreason: any
 The reason the promise was rejected.
Returns Promise<T>
A new rejected Promise.
Inherited from Promise.reject
- Defined in 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/typescript/lib/lib.es2015.promise.d.ts:66
resolve<T>(value: T): 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/typescript/lib/lib.es2015.promise.d.ts:72
resolve<T>(value: T | PromiseLike<T>): 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/typescript/lib/lib.es2015.promise.d.ts:78

Class APIPromise<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns APIPromise<T>

Properties

Readonly[toStringTag]

Static Readonly[species]

Methods

_thenUnwrap

Type Parameters

Parameters

Returns APIPromise<U>

asResponse

Returns Promise<Response>

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

finally

Parameters

Returns Promise<T>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

withResponse

Returns Promise<{ data: T; response: Response }>

Staticall

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

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

StaticallSettled

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Staticrace

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Staticreject

Type Parameters

Parameters

Returns Promise<T>

Staticresolve

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Settings

On This Page

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`all

`Static`allSettled

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

`Static`race

`Static`reject

`Static`resolve