Interface Request

This Fetch API interface represents a resource request.

MDN Reference

interface Request {
    body: ReadableStream<Uint8Array>;
    Body: string;
    bodyUsed: boolean;
    cache: RequestCache;
    ClientIpAddress: string;
    credentials: RequestCredentials;
    Customer: Customer;
    destination: RequestDestination;
    Files: FileInstance[];
    Form: Object;
    headers: Headers;
    Headers: Object;
    Impersonator: Customer;
    integrity: string;
    keepalive: boolean;
    method: string;
    Method: string;
    mode: RequestMode;
    Query: Object;
    redirect: RequestRedirect;
    referrer: string;
    referrerPolicy: ReferrerPolicy;
    signal: AbortSignal;
    url: string;
    arrayBuffer(): Promise<ArrayBuffer>;
    blob(): Promise<Blob>;
    clone(): Request;
    formData(): Promise<FormData>;
    json(): Promise<any>;
    text(): Promise<string>;
}

Hierarchy

  • Body
  • _Request
    • Request

Properties

body Body bodyUsed cache ClientIpAddress credentials Customer destination Files Form headers Headers Impersonator integrity keepalive method Method mode Query redirect referrer referrerPolicy signal url

Methods

arrayBuffer blob clone formData json text

Properties

Readonlybody

body: ReadableStream<Uint8Array>

MDN Reference

Body

Body: string

Body content of the request.

ReadonlybodyUsed

bodyUsed: boolean

MDN Reference

Readonlycache

cache: RequestCache

Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.

MDN Reference

ClientIpAddress

ClientIpAddress: string

Client's IP address making the request.

Readonlycredentials

credentials: RequestCredentials

Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.

MDN Reference

Customer

Customer: Customer

Customer associated with the request.

Readonlydestination

destination: RequestDestination

Returns the kind of resource requested by request, e.g., "document" or "script".

MDN Reference

Files

Files: FileInstance[]

Files uploaded as part of the request.

Form

Form: Object

Form data associated with the request.

Readonlyheaders

headers: Headers

Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header.

MDN Reference

Headers

Headers: Object

Headers of the request.

Impersonator

Impersonator: Customer

Customer impersonator if available.

Readonlyintegrity

integrity: string

Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI]

MDN Reference

Readonlykeepalive

keepalive: boolean

Returns a boolean indicating whether or not request can outlive the global in which it was created.

Readonlymethod

method: string

Returns request's HTTP method, which is "GET" by default.

MDN Reference

Method

Method: string

The HTTP method of the request.

Readonlymode

mode: RequestMode

Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.

MDN Reference

Query

Query: Object

Query parameters associated with the request.

Readonlyredirect

redirect: RequestRedirect

Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.

MDN Reference

Readonlyreferrer

referrer: string

Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made.

MDN Reference

ReadonlyreferrerPolicy

referrerPolicy: ReferrerPolicy

Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.

MDN Reference

Readonlysignal

signal: AbortSignal

Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.

MDN Reference

Readonlyurl

url: string

Returns the URL of request as a string.

MDN Reference

Methods

arrayBuffer

  • arrayBuffer(): Promise<ArrayBuffer>

  • MDN Reference

    Returns Promise<ArrayBuffer>

blob

  • blob(): Promise<Blob>

  • MDN Reference

    Returns Promise<Blob>

clone

formData

  • formData(): Promise<FormData>

  • MDN Reference

    Returns Promise<FormData>

json

  • json(): Promise<any>

  • MDN Reference

    Returns Promise<any>

text

  • text(): Promise<string>

  • MDN Reference

    Returns Promise<string>

Settings

Member Visibility

On This Page

Properties
Methods