Interface BodyReader

A reader over a response body stream.

Hierarchy

BodyReader

Index

Methods

Methods

`Optional` cancel

cancel(): void | Promise<unknown>
Releases the reader and its connection.

Returns void | Promise<unknown>
- Defined in packages/shared/common/src/api/platform/Requests.ts:78

read

read(): Promise<{
done: boolean;
value?: Uint8Array;
}>
Resolves with the next chunk, or with done: true when the server ends the stream. Rejects when the connection terminates before the server ends the stream.

Returns Promise<{
done: boolean;
value?: Uint8Array;
}>
- Defined in packages/shared/common/src/api/platform/Requests.ts:73

Generated using TypeDoc