PokéRogue
    Preparing search index...

    Interface XMLHttpRequest

    XMLHttpRequest (XHR) objects are used 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.

    MDN Reference

    interface XMLHttpRequest {
        DONE: 4;
        HEADERS_RECEIVED: 2;
        LOADING: 3;
        onabort: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        onerror: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        onload: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        onloadend: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        onloadstart: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        onreadystatechange: ((this: XMLHttpRequest, ev: Event) => any) | null;
        ontimeout: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
        OPENED: 1;
        readyState: number;
        response: any;
        responseText: string;
        responseType: XMLHttpRequestResponseType;
        responseURL: string;
        responseXML: Document | null;
        status: number;
        statusText: string;
        timeout: number;
        UNSENT: 0;
        upload: XMLHttpRequestUpload;
        withCredentials: boolean;
        abort(): void;
        addEventListener<K extends keyof XMLHttpRequestEventMap>(
            type: K,
            listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        getAllResponseHeaders(): string;
        getResponseHeader(name: string): string | null;
        open(method: string, url: string | URL): void;
        open(
            method: string,
            url: string | URL,
            async: boolean,
            username?: string | null,
            password?: string | null,
        ): void;
        overrideMimeType(mime: string): void;
        removeEventListener<K extends keyof XMLHttpRequestEventMap>(
            type: K,
            listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        send(body?: Document | XMLHttpRequestBodyInit | null): void;
        setRequestHeader(name: string, value: string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    DONE HEADERS_RECEIVED LOADING onabort onerror onload onloadend onloadstart onprogress onreadystatechange ontimeout OPENED readyState response responseText responseType responseURL responseXML status statusText timeout UNSENT upload withCredentials

    Methods

    abort addEventListener dispatchEvent getAllResponseHeaders getResponseHeader open overrideMimeType removeEventListener send setRequestHeader

    Properties

    DONE: 4
    HEADERS_RECEIVED: 2
    LOADING: 3
    onabort: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    onerror: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    onload: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    onloadend: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    onloadstart: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    onreadystatechange: ((this: XMLHttpRequest, ev: Event) => any) | null

    MDN Reference

    ontimeout: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null
    OPENED: 1
    readyState: number

    The XMLHttpRequest.readyState property returns the state an XMLHttpRequest client is in. An XHR client exists in one of the following states:

    MDN Reference

    response: any

    The XMLHttpRequest response property returns the response's body content as an ArrayBuffer, a Blob, a Document, a JavaScript Object, or a string, depending on the value of the request's responseType property.

    MDN Reference

    responseText: string

    The read-only XMLHttpRequest property responseText returns the text received from a server following a request being sent.

    MDN Reference

    responseType: XMLHttpRequestResponseType

    The XMLHttpRequest property responseType is an enumerated string value specifying the type of data contained in the response.

    MDN Reference

    responseURL: string

    The read-only XMLHttpRequest.responseURL property returns the serialized URL of the response or the empty string if the URL is null. If the URL is returned, any URL fragment present in the URL will be stripped away. The value of responseURL will be the final URL obtained after any redirects.

    MDN Reference

    responseXML: Document | null

    The XMLHttpRequest.responseXML read-only property returns a Document containing the HTML or XML retrieved by the request; or null if the request was unsuccessful, has not yet been sent, or if the data can't be parsed as XML or HTML.

    MDN Reference

    status: number

    The read-only XMLHttpRequest.status property returns the numerical HTTP status code of the XMLHttpRequest's response.

    MDN Reference

    statusText: string

    The read-only XMLHttpRequest.statusText property returns a string containing the response's status message as returned by the HTTP server. Unlike XMLHttpRequest.status which indicates a numerical status code, this property contains the text of the response status, such as "OK" or "Not Found". If the request's readyState is in UNSENT or OPENED state, the value of statusText will be an empty string.

    MDN Reference

    timeout: number

    The XMLHttpRequest.timeout property is an unsigned long representing the number of milliseconds a request can take before automatically being terminated. The default value is 0, which means there is no timeout. Timeout shouldn't be used for synchronous XMLHttpRequests requests used in a document environment or it will throw an InvalidAccessError exception. When a timeout happens, a timeout event is fired.

    MDN Reference

    UNSENT: 0
    upload: XMLHttpRequestUpload

    The XMLHttpRequest upload property returns an XMLHttpRequestUpload object that can be observed to monitor an upload's progress.

    MDN Reference

    withCredentials: boolean

    The XMLHttpRequest.withCredentials property is a boolean value that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authentication headers or TLS client certificates. Setting withCredentials has no effect on same-origin requests.

    MDN Reference

    Methods

    • The XMLHttpRequest.abort() method aborts the request if it has already been sent. When a request is aborted, its readyState is changed to XMLHttpRequest.UNSENT (0) and the request's status code is set to 0.

      MDN Reference

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • The XMLHttpRequest method getAllResponseHeaders() returns all the response headers, separated by CRLF, as a string, or returns null if no response has been received.

      MDN Reference

      Returns string

    • The XMLHttpRequest method getResponseHeader() returns the string containing the text of a particular header's value.

      MDN Reference

      Parameters

      • name: string

      Returns string | null

    • The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.

      MDN Reference

      Parameters

      • method: string
      • url: string | URL

      Returns void

    • Parameters

      • method: string
      • url: string | URL
      • async: boolean
      • Optionalusername: string | null
      • Optionalpassword: string | null

      Returns void

    • The XMLHttpRequest method overrideMimeType() specifies a MIME type other than the one provided by the server to be used instead when interpreting the data being transferred in a request.

      MDN Reference

      Parameters

      • mime: string

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Type Parameters

      Parameters

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      Returns void

    • The XMLHttpRequest method setRequestHeader() sets the value of an HTTP request header. When using setRequestHeader(), you must call it after calling open(), but before calling send(). If this method is called several times with the same header, the values are merged into one single request header.

      MDN Reference

      Parameters

      • name: string
      • value: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods