Response

This Fetch API interface represents the response to a request.

class Response implements Body {

constructor(body?: BodyInit | null, init?: ResponseInit);


readonly body: ReadableStream<Uint8Array> | null;


readonly bodyUsed: boolean;


readonly headers: Headers;


readonly ok: boolean;


readonly redirected: boolean;


readonly status: number;


readonly statusText: string;


readonly trailer: Promise<Headers>;


readonly type: ResponseType;


readonly url: string;



arrayBuffer(): Promise<ArrayBuffer>;

blob(): Promise<Blob>;

clone(): Response;

formData(): Promise<FormData>;

json(): Promise<any>;

text(): Promise<string>;


static error(): Response;

static json(data: unknown, init?: ResponseInit): Response;

static redirect(url: string | URL, status?: number): Response;

}

Implements

Body

Constructors

new Response(body?: BodyInit | null, init?: ResponseInit)

Properties

body: ReadableStream<Uint8Array> | null

A simple getter used to expose a ReadableStream of the body contents.

bodyUsed: boolean

Stores a Boolean that declares whether the body has been used in a response yet.

headers: Headers

ok: boolean

redirected: boolean

status: number

statusText: string

trailer: Promise<Headers>

type: ResponseType

url: string

Methods

arrayBuffer(): Promise<ArrayBuffer>

Takes a Response stream and reads it to completion. It returns a promise that resolves with an ArrayBuffer.

blob(): Promise<Blob>

Takes a Response stream and reads it to completion. It returns a promise that resolves with a Blob.

clone(): Response

formData(): Promise<FormData>

Takes a Response stream and reads it to completion. It returns a promise that resolves with a FormData object.

json(): Promise<any>

Takes a Response stream and reads it to completion. It returns a promise that resolves with the result of parsing the body text as JSON.

text(): Promise<string>

Takes a Response stream and reads it to completion. It returns a promise that resolves with a USVString (text).

Static Methods

error(): Response

json(data: unknown, init?: ResponseInit): Response

redirect(url: string | URL, status?: number): Response