Interface VMScriptGMXHRDetails<T>

interface VMScriptGMXHRDetails<T> {
    anonymous?: boolean;
    binary?: boolean;
    context?: unknown;
    data?: string | ArrayBuffer | DataView | Blob | FormData | URLSearchParams | ReadableStream<any> | TypedArray;
    headers?: Record<string, string>;
    method?: string;
    onabort?: ((resp) => void);
    onerror?: ((resp) => void);
    onload?: ((resp) => void);
    onloadend?: ((resp) => void);
    onloadstart?: ((resp) => void);
    onprogress?: ((resp) => void);
    onreadystatechange?: ((resp) => void);
    ontimeout?: ((resp) => void);
    overrideMimeType?: string;
    password?: string;
    responseType?: VMScriptResponseType;
    timeout?: number;
    url: string;
    user?: string;
}

Type Parameters

  • T

Hierarchy (view full)

Properties

anonymous? binary? context? data? headers? method? onabort? onerror? onload? onloadend? onloadstart? onprogress? onreadystatechange? ontimeout? overrideMimeType? password? responseType? timeout? url user?

Properties

Optional anonymous

anonymous?: boolean

When set to true, no cookie will be sent with the request and the response cookies will be ignored. The default value is false.

Optional binary

binary?: boolean

Send the data string as a blob. This is for compatibility with Tampermonkey/Greasemonkey, where only string type is allowed in data.

Optional context

context?: unknown

Can be an object and will be assigned to context of the response object.

Optional data

data?: string | ArrayBuffer | DataView | Blob | FormData | URLSearchParams | ReadableStream<any> | TypedArray

Data to send with the request, usually for POST and PUT requests.

Optional headers

headers?: Record<string, string>

Some special headers are also allowed:

  • Cookie
  • Host
  • Origin
  • Referer
  • User-Agent

Optional method

method?: string

HTTP method, default as GET.

Optional onabort

onabort?: ((resp) => void)

Type declaration

Optional onerror

onerror?: ((resp) => void)

Type declaration

Optional onload

onload?: ((resp) => void)

Type declaration

Optional onloadend

onloadend?: ((resp) => void)

Type declaration

Optional onloadstart

onloadstart?: ((resp) => void)

Type declaration

Optional onprogress

onprogress?: ((resp) => void)

Type declaration

Optional onreadystatechange

onreadystatechange?: ((resp) => void)

Type declaration

Optional ontimeout

ontimeout?: ((resp) => void)

Type declaration

Optional overrideMimeType

overrideMimeType?: string

A MIME type to specify with the request.

Optional password

password?: string

Password for authentication.

Optional responseType

responseType?: VMScriptResponseType

One of the following:

  • text (default value)
  • json
  • blob
  • arraybuffer
  • document

Optional timeout

timeout?: number

Time to wait for the request, none by default.

url

url: string

URL relative to current page is also allowed.

Optional user

user?: string

User for authentication.

Settings

Member Visibility

Theme

On This Page

anonymousbinarycontextdataheadersmethodonabortonerroronloadonloadendonloadstartonprogressonreadystatechangeontimeoutoverrideMimeTypepasswordresponseTypetimeouturluser