Interface FetchStreamPromise<H, P, RH>

A stream-mode FetchPromise that also supports async iteration over chunks.

Returned by .stream() to signal that the caller wants raw streaming access to the response body as Uint8Array chunks.

interface FetchStreamPromise<H, P, RH> {
    "[toStringTag]": string;
    get directive(): ResponseDirective | undefined;
    get isAborted(): boolean;
    get isFinished(): boolean;
    get isStream(): boolean;
    "[asyncIterator]"(): AsyncIterator<Uint8Array<ArrayBufferLike>>;
    abort(reason?: string): void;
    arrayBuffer(): FetchPromise<ArrayBuffer, H, P, RH>;
    blob(): FetchPromise<Blob, H, P, RH>;
    catch<TResult = never>(
        onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
    ): Promise<FetchResponse<Response, H, P, RH> | TResult>;
    finally(
        onfinally?: (() => void) | null,
    ): Promise<FetchResponse<Response, H, P, RH>>;
    formData(): FetchPromise<FormData, H, P, RH>;
    json(): FetchPromise<Response, H, P, RH>;
    raw(): FetchPromise<Response, H, P, RH>;
    stream(): FetchStreamPromise<H, P, RH>;
    text(): FetchPromise<string, H, P, RH>;
    then<TResult1 = FetchResponse<Response, H, P, RH>, TResult2 = never>(
        onfulfilled?:
            | ((value: FetchResponse) => TResult1 | PromiseLike<TResult1>)
            | null,
        onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
    ): Promise<TResult1 | TResult2>;
}

Type Parameters

Hierarchy (View Summary)

FetchPromise<Response, H, P, RH>
AsyncIterable<Uint8Array>
- FetchStreamPromise

Index

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

Accessors

directive

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

Returns ResponseDirective | undefined
Inherited from FetchPromise.directive
- 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
Inherited from FetchPromise.isAborted
- 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
Inherited from FetchPromise.isFinished
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:41

isStream

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

Returns boolean
Inherited from FetchPromise.isStream
- 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);
    }
```
Inherited from FetchPromise.[asyncIterator]
- 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
Inherited from FetchPromise.abort
- 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>
Inherited from FetchPromise.arrayBuffer
- 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>
Inherited from FetchPromise.blob
- 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<Response, 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<Response, H, P, RH> | TResult>
A Promise for the completion of the callback.
Inherited from FetchPromise.catch
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1564

finally

finally(
onfinally?: (() => void) | null,
): Promise<FetchResponse<Response, 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<Response, H, P, RH>>
A Promise for the completion of the callback.
Inherited from FetchPromise.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>
Inherited from FetchPromise.formData
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:97

json

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

Returns FetchPromise<Response, H, P, RH>
Inherited from FetchPromise.json
- 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>
Inherited from FetchPromise.raw
- 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>
Inherited from FetchPromise.stream
- 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>
Inherited from FetchPromise.text
- Defined in packages/fetch/dist/types/engine/fetch-promise.d.ts:85

then

then<TResult1 = FetchResponse<Response, 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<Response, 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 FetchPromise.then
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1557

Interface FetchStreamPromise<H, P, RH>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Readonly[toStringTag]

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<Response, H, P, RH> | TResult>

finally

Parameters

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

formData

Returns FetchPromise<FormData, H, P, RH>

json

Returns FetchPromise<Response, 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>

Settings

On This Page

`Readonly`[toStringTag]