Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface XMLHttpRequest

Use XMLHttpRequest (XHR) objects to interact with servers. You can retrieve data from a URL without having to do a full page refresh. This enables a Web page to update just part of a page without disrupting what the user is doing.

Hierarchy

Index

Properties

Readonly DONE

DONE: number

Readonly HEADERS_RECEIVED

HEADERS_RECEIVED: number

Readonly LOADING

LOADING: number

Readonly OPENED

OPENED: number

Readonly UNSENT

UNSENT: number

XMLHttpRequestEventTarget

XMLHttpRequestEventTarget: { constructor: any; prototype: XMLHttpRequestEventTarget }

Type declaration

onabort

onabort: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

onerror

onerror: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

onload

onload: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

onloadend

onloadend: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

onloadstart

onloadstart: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

onprogress

onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

onreadystatechange

onreadystatechange: ((this: XMLHttpRequest, ev: Event) => any) | null

ontimeout

ontimeout: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

Readonly readyState

readyState: number

Returns client's state.

Readonly response

response: any

Returns the response's body.

Readonly responseText

responseText: string

Returns the text response.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "text".

responseType

Returns the response type.

Can be set to change the response type. Values are: the empty string (default), "arraybuffer", "blob", "document", "json", and "text".

When set: setting to "document" is ignored if current global object is not a Window object.

When set: throws an "InvalidStateError" DOMException if state is loading or done.

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

Readonly responseURL

responseURL: string

Readonly responseXML

responseXML: Document | null

Returns the document response.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "document".

Readonly status

status: number

Readonly statusText

statusText: string

timeout

timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and the synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

Readonly upload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

withCredentials

withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

When set: throws an "InvalidStateError" DOMException if state is not unsent or opened, or if the send() flag is set.

Methods

abort

  • abort(): void
  • Cancels any network activity.

    Returns void

addEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

getAllResponseHeaders

  • getAllResponseHeaders(): string
  • Returns string

getResponseHeader

  • getResponseHeader(name: string): string | null
  • Parameters

    • name: string

    Returns string | null

open

  • open(method: string, url: string): void
  • open(method: string, url: string, async: boolean, username?: string | null, password?: string | null): void
  • Sets the request method, request URL, and synchronous flag.

    Throws a "SyntaxError" DOMException if either method is not a valid HTTP method or url cannot be parsed.

    Throws a "SecurityError" DOMException if method is a case-insensitive match for CONNECT, TRACE, or TRACK.

    Throws an "InvalidAccessError" DOMException if async is false, current global object is a Window object, and the timeout attribute is not zero or the responseType attribute is not the empty string.

    Parameters

    • method: string
    • url: string

    Returns void

  • Parameters

    • method: string
    • url: string
    • async: boolean
    • Optional username: string | null
    • Optional password: string | null

    Returns void

overrideMimeType

  • overrideMimeType(mime: string): void
  • Acts as if the Content-Type header value for response is mime. (It does not actually change the header though.)

    Throws an "InvalidStateError" DOMException if state is loading or done.

    Parameters

    • mime: string

    Returns void

removeEventListener

send

  • Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

    Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

    Parameters

    Returns void

setRequestHeader

  • setRequestHeader(name: string, value: string): void
  • Combines a header in author request headers.

    Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

    Throws a "SyntaxError" DOMException if name is not a header name or if value is not a header value.

    Parameters

    • name: string
    • value: string

    Returns void

Generated using TypeDoc