Class FetchPromise<T, H, P, RH>

Extended Promise that carries a response directive for the fetch engine.

Enables a fluent API where callers declare their expected response type (e.g. .json(), .text(), .blob()) before awaiting. The directive is read by the executor to determine how to parse the response body.

An override guard prevents setting the directive more than once, catching accidental double-calls that would silently discard the first directive.

Example

const user = await api.get('/users/1').json();
    const html = await api.get('/page').text();
    const file = await api.get('/file').blob();

Type Parameters

T = unknown
Type of the parsed response data
H = unknown
Type of request headers
P = unknown
Type of request params
RH = unknown
Type of response headers

Hierarchy (View Summary)

Promise<FetchResponse<T, H, P, RH>>
- FetchPromise
  - FetchStreamPromise

Index

Constructors

constructor

new FetchPromise<T = unknown, H = unknown, P = unknown, RH = unknown>(
    executor: (
        resolve: (
            value:
                | FetchResponse<T, H, P, RH>
                | PromiseLike<FetchResponse<T, H, P, RH>>,
        ) => void,
        reject: (reason?: any) => void,
    ) => void,
): FetchPromise<T>
Creates a new Promise.
Type Parameters
- T = unknown
  Type of the parsed response data
- H = unknown
  Type of request headers
- P = unknown
  Type of request params
- RH = unknown
  Type of response headers
Parameters
- executor: (
      resolve: (
          value:
              | FetchResponse<T, H, P, RH>
              | PromiseLike<FetchResponse<T, H, P, RH>>,
      ) => void,
      reject: (reason?: any) => void,
  ) => void
  A callback used to initialize the promise. This callback is passed two arguments: a resolve callback used to resolve the promise with a value or the result of another promise, and a reject callback used to reject the promise with a provided reason or error.
Returns FetchPromise<T>
Inherited from Promise<FetchResponse<T, H, P, RH>>.constructor
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.promise.d.ts:31

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Accessors

directive

get directive(): ResponseDirective | undefined
The active response directive, if any.

Returns ResponseDirective | undefined
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:73

isAborted

get isAborted(): boolean
Whether the request was aborted, either via abort() or an external signal on the controller.

Returns boolean
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:46

isFinished

get isFinished(): boolean
Whether the executor has resolved or rejected (without abort).

Returns boolean
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:41

isStream

get isStream(): boolean
Whether stream mode is active.

Returns boolean
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:77

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<Uint8Array<ArrayBufferLike>>
Async iterator that yields response body chunks as Uint8Array.

Only available after calling .stream(). Reads from the underlying ReadableStream and releases the reader lock when iteration ends.

Returns AsyncIterator<Uint8Array<ArrayBufferLike>>
Example
```
for await (const chunk of api.get('/large-file').stream()) {
        process(chunk);
    }
```
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:120

abort

abort(reason?: string): void
Abort the in-flight request.

Sets isAborted and delegates to the stored AbortController. Safe to call even when no controller is present (plain constructor).
Parameters
- Optionalreason: string
Returns void
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:53

arrayBuffer

arrayBuffer(): FetchPromise<ArrayBuffer, H, P, RH>
Parse the response body as an ArrayBuffer.

Returns FetchPromise<ArrayBuffer, H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:93

blob

blob(): FetchPromise<Blob, H, P, RH>
Parse the response body as a Blob.

Returns FetchPromise<Blob, H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:89

catch

catch<TResult = never>(
onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
): Promise<FetchResponse<T, H, P, RH> | 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<FetchResponse<T, H, P, RH> | TResult>
A Promise for the completion of the callback.
Inherited from Promise.catch
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1564

finally

finally(onfinally?: (() => void) | null): Promise<FetchResponse<T, H, P, RH>>
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<FetchResponse<T, H, P, RH>>
A Promise for the completion of the callback.
Inherited from Promise.finally
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2018.promise.d.ts:29

formData

formData(): FetchPromise<FormData, H, P, RH>
Parse the response body as FormData.

Returns FetchPromise<FormData, H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:97

json

json(): FetchPromise<T, H, P, RH>
Parse the response body as JSON.

Returns FetchPromise<T, H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:81

raw

raw(): FetchPromise<Response, H, P, RH>
Return the raw Response object without parsing.

Returns FetchPromise<Response, H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:101

stream

stream(): FetchStreamPromise<H, P, RH>
Enable streaming mode for the response.

Returns the raw Response and marks the promise for async iteration over response body chunks.

Returns FetchStreamPromise<H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:108

text

text(): FetchPromise<string, H, P, RH>
Parse the response body as plain text.

Returns FetchPromise<string, H, P, RH>
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:85

then

then<TResult1 = FetchResponse<T, H, P, RH>, TResult2 = never>(
    onfulfilled?:
        | ((value: FetchResponse) => 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 = FetchResponse<T, H, P, RH>
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: FetchResponse) => 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.
Inherited from Promise.then
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1557

`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/.pnpm/[email protected]/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/.pnpm/[email protected]/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/.pnpm/[email protected]/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/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2020.promise.d.ts:46

`Static`any

any<T extends [] | readonly unknown[]>(values: T): 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/[email protected]/node_modules/typescript/lib/lib.es2021.promise.d.ts:40
any<T>(values: Iterable<T | PromiseLike<T>>): 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/[email protected]/node_modules/typescript/lib/lib.es2021.promise.d.ts:47

`Static`create

create<T, H, P, RH>(
executor: () => Promise<FetchResponse<T, H, P, RH>>,
controller: AbortController,
): FetchPromise<T, H, P, RH>
Factory that wires an executor and AbortController into a FetchPromise with automatic finish/abort tracking.

Replaces the previous pattern of patching abort state onto a plain promise, giving callers a typed, first-class abort surface.
Type Parameters
- T
- H
- P
- RH
Parameters
- executor: () => Promise<FetchResponse<T, H, P, RH>>
- controller: AbortController
Returns FetchPromise<T, H, P, RH>
Example
```
const controller = new AbortController();
    const fp = FetchPromise.create(
        () => engine.execute(request, controller.signal),
        controller
    );
    fp.abort('user cancelled');
```
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:69

`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/.pnpm/[email protected]/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/.pnpm/[email protected]/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/.pnpm/[email protected]/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/[email protected]/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/.pnpm/[email protected]/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/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.promise.d.ts:78

`Static`try

try<T, U extends unknown[]>(
callbackFn: (...args: U) => T | PromiseLike<T>,
...args: U,
): Promise<Awaited<T>>
Takes a callback of any kind (returns or throws, synchronously or asynchronously) and wraps its result in a Promise.
Type Parameters
- T
- U extends unknown[]
Parameters
- callbackFn: (...args: U) => T | PromiseLike<T>
  A function that is called synchronously. It can do anything: either return a value, throw an error, or return a promise.
- ...args: U
  Additional arguments, that will be passed to the callback.
Returns Promise<Awaited<T>>
A Promise that is:
- Already fulfilled, if the callback synchronously returns a value.
- Already rejected, if the callback synchronously throws an error.
- Asynchronously fulfilled or rejected, if the callback returns a promise.
Inherited from Promise.try
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.esnext.promise.d.ts:33

`Static`withResolvers

withResolvers<T>(): PromiseWithResolvers<T>
Creates a new Promise and returns it in an object, along with its resolve and reject functions.
Type Parameters
- T
Returns PromiseWithResolvers<T>
An object with the properties promise, resolve, and reject.
```
const { promise, resolve, reject } = Promise.withResolvers<T>();
```
Inherited from Promise.withResolvers
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2024.promise.d.ts:34

Class FetchPromise<T, H, P, RH>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FetchPromise<T>

Properties

Readonly[toStringTag]

Static Readonly[species]

Accessors

directive

Returns ResponseDirective | undefined

isAborted

Returns boolean

isFinished

Returns boolean

isStream

Returns boolean

Methods

[asyncIterator]

Returns AsyncIterator<Uint8Array<ArrayBufferLike>>

Example

abort

Parameters

Returns void

arrayBuffer

Returns FetchPromise<ArrayBuffer, H, P, RH>

blob

Returns FetchPromise<Blob, H, P, RH>

catch

Type Parameters

Parameters

Returns Promise<FetchResponse<T, H, P, RH> | TResult>

finally

Parameters

Returns Promise<FetchResponse<T, H, P, RH>>

formData

Returns FetchPromise<FormData, H, P, RH>

json

Returns FetchPromise<T, H, P, RH>

raw

Returns FetchPromise<Response, H, P, RH>

stream

Returns FetchStreamPromise<H, P, RH>

text

Returns FetchPromise<string, H, P, RH>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Staticall

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

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

StaticallSettled

Type Parameters

Parameters

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

Type Parameters

Parameters

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

Staticany

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Staticcreate

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`all

`Static`allSettled

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

`Static`any

`Static`create

`Static`race

`Static`reject

`Static`resolve

`Static`try

`Static`withResolvers