Interface GMRequestBase<T>

interface GMRequestBase<T> {
    anonymous?: boolean;
    context?: unknown;
    headers?: Record<string, 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;
    password?: string;
    timeout?: number;
    url: string;
    user?: string;
}

Type Parameters

  • T

Hierarchy (View Summary)

Properties

anonymous? context? headers? onabort? onerror? onload? onloadend? onloadstart? onprogress? onreadystatechange? ontimeout? password? 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.

Optionalcontext

context?: unknown

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

Optionalheaders

headers?: Record<string, string>

Some special headers are also allowed:

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

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

Optionalpassword

password?: string

Password for authentication.

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