Interface VMScriptGMXHRDetails<T>

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

Type Parameters

  • T

Hierarchy (View Summary)

Properties

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

Properties

Optionalanonymous

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.

Optionalbinary

binary?: boolean

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

Optionalcontext

context?: unknown

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

Optionaldata

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

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

Optionalheaders

headers?: Record<string, string>

Some special headers are also allowed:

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

Optionalmethod

method?: string

HTTP method, default as GET.

Optionalonabort

onabort?: (resp: VMScriptResponseObject<T>) => void

Optionalonerror

onerror?: (resp: VMScriptResponseObject<T>) => void

Optionalonload

onload?: (resp: VMScriptResponseObject<T>) => void

Optionalonloadend

onloadend?: (resp: VMScriptResponseObject<T>) => void

Optionalonloadstart

onloadstart?: (resp: VMScriptResponseObject<T>) => void

Optionalonprogress

onprogress?: (resp: VMScriptResponseObject<T>) => void

Optionalonreadystatechange

onreadystatechange?: (resp: VMScriptResponseObject<T>) => void

Optionalontimeout

ontimeout?: (resp: VMScriptResponseObject<T>) => void

OptionaloverrideMimeType

overrideMimeType?: string

A MIME type to specify with the request.

Optionalpassword

password?: string

Password for authentication.

OptionalresponseType

responseType?: VMScriptResponseType

One of the following:

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

Optionaltimeout

timeout?: number

Time to wait for the request, none by default.

url

url: string

URL relative to current page is also allowed.

Optionaluser

user?: string

User for authentication.

Settings

Member Visibility

On This Page

Properties