Interface: XMLHttpRequest

Defined in: types/desktop-engine.d.ts:4179

XMLHttpRequest, for libraries that use it; on top of fetch, with the same URLs and rules. Asynchronous only.

Extends

• XMLHttpRequestEventTarget

Properties

DONE

readonly DONE: 4;

Defined in: types/desktop-engine.d.ts:4219

---

HEADERS_RECEIVED

readonly HEADERS_RECEIVED: 2;

Defined in: types/desktop-engine.d.ts:4217

---

LOADING

readonly LOADING: 3;

Defined in: types/desktop-engine.d.ts:4218

---

onabort

onabort: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4160

Inherited from

XMLHttpRequestEventTarget.onabort

---

onerror

onerror: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4161

Inherited from

XMLHttpRequestEventTarget.onerror

---

onload

onload: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4162

Inherited from

XMLHttpRequestEventTarget.onload

---

onloadend

onloadend: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4164

Inherited from

XMLHttpRequestEventTarget.onloadend

---

onloadstart

onloadstart: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4158

Inherited from

XMLHttpRequestEventTarget.onloadstart

---

onprogress

onprogress: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4159

Inherited from

XMLHttpRequestEventTarget.onprogress

---

onreadystatechange

onreadystatechange: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4182

---

ontimeout

ontimeout: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4163

Inherited from

XMLHttpRequestEventTarget.ontimeout

---

OPENED

readonly OPENED: 1;

Defined in: types/desktop-engine.d.ts:4216

---

readyState

readonly readyState: 0 | 1 | 2 | 3 | 4;

Defined in: types/desktop-engine.d.ts:4181

UNSENT, OPENED, HEADERS_RECEIVED, LOADING or DONE

---

response

readonly response: any;

Defined in: types/desktop-engine.d.ts:4193

The body as responseType asks: the text (decoded with the response's charset, UTF-8 by default), an ArrayBuffer, a Blob or the parsed JSON (null when it isn't JSON); null until the request is done, but the text while loading

---

responseText

readonly responseText: string;

Defined in: types/desktop-engine.d.ts:4195

The text so far; throws an "InvalidStateError" DOMException unless responseType is "" or "text"

---

responseType

responseType: XMLHttpRequestResponseType;

Defined in: types/desktop-engine.d.ts:4188

What response is; "document" isn't supported, its response is null

---

responseURL

readonly responseURL: string;

Defined in: types/desktop-engine.d.ts:4186

---

responseXML

readonly responseXML: null;

Defined in: types/desktop-engine.d.ts:4197

Always null: there are no documents

---

status

readonly status: number;

Defined in: types/desktop-engine.d.ts:4184

0 before the response or when the request failed

---

statusText

readonly statusText: string;

Defined in: types/desktop-engine.d.ts:4185

---

timeout

timeout: number;

Defined in: types/desktop-engine.d.ts:4199

Milliseconds before the request fails with a timeout event, 0 (the default) for none

---

UNSENT

readonly UNSENT: 0;

Defined in: types/desktop-engine.d.ts:4215

---

upload

readonly upload: XMLHttpRequestUpload;

Defined in: types/desktop-engine.d.ts:4202

---

withCredentials

withCredentials: boolean;

Defined in: types/desktop-engine.d.ts:4201

Accepted for compatibility: cookies are always sent

Methods

abort()

abort(): void;

Defined in: types/desktop-engine.d.ts:4211

Cancels the request: abort and loadend events, then readyState is UNSENT

Returns

void

---

addEventListener()

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:3810

Type Parameters

Type Parameter
K extends keyof XMLHttpRequestEventMap

Parameters

Parameter	Type
type	K
listener	(this, event) => void
options?	AddEventListenerOptions

Returns

void

Inherited from

XMLHttpRequestEventTarget.addEventListener

---

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: types/desktop-engine.d.ts:3813

Returns false when a listener called preventDefault() on a cancelable event

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

XMLHttpRequestEventTarget.dispatchEvent

---

getAllResponseHeaders()

getAllResponseHeaders(): string;

Defined in: types/desktop-engine.d.ts:4214

"name: value\r\n" for each header, lowercased names, sorted

Returns

string

---

getResponseHeader()

getResponseHeader(name): string | null;

Defined in: types/desktop-engine.d.ts:4212

Parameters

Parameter	Type
name	string

Returns

string | null

---

open()

open(
   method, 
   url, 
   async?, 
   username?, 
   password?
): void;

Defined in: types/desktop-engine.d.ts:4204

async must be true: synchronous requests throw an "InvalidAccessError" DOMException

Parameters

Parameter	Type
method	string
url	string | URL
async?	boolean
username?	string | null
password?	string | null

Returns

void

---

overrideMimeType()

overrideMimeType(mime): void;

Defined in: types/desktop-engine.d.ts:4207

The MIME type (and charset) the response is read with

Parameters

Parameter	Type
mime	string

Returns

void

---

removeEventListener()

removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:3811

Type Parameters

Type Parameter
K extends keyof XMLHttpRequestEventMap

Parameters

Parameter	Type
type	K
listener	(this, event) => void

Returns

void

Inherited from

XMLHttpRequestEventTarget.removeEventListener

---

send()

send(body?): void;

Defined in: types/desktop-engine.d.ts:4209

Sends the request; the body is ignored for GET and HEAD

Parameters

Parameter	Type
body?	BodyInit | null

Returns

void

---

setRequestHeader()

setRequestHeader(name, value): void;

Defined in: types/desktop-engine.d.ts:4205

Parameters

Parameter	Type
name	string
value	string

Returns

void