123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
/** * The built in types for Deno do not include the `XMLHttpRequest` and * associated types, so if you are type checking your code and get errors about * them not being defined, there are a couple of solutions. * * If all you want to do is "polyfill" the types, they are available here under * `./globals` export. You can either import them like: * * ```ts * import type {} from "jsr:/@kitsonk/xhr/globals"; * ``` * * Or using the triple slash reference like: * * ```ts * /// <reference types="jsr:/@kitsonk/xhr/globals" /> * ``` * * @module */
// deno-lint-ignore-file no-explicit-any
type XMLHttpRequestResponseType =  | ""  | "arraybuffer"  | "blob"  | "document"  | "json"  | "text";
interface XMLHttpRequestEventTargetEventMap {  "abort": ProgressEvent<XMLHttpRequestEventTarget>;  "error": ProgressEvent<XMLHttpRequestEventTarget>;  "load": ProgressEvent<XMLHttpRequestEventTarget>;  "loadend": ProgressEvent<XMLHttpRequestEventTarget>;  "loadstart": ProgressEvent<XMLHttpRequestEventTarget>;  "progress": ProgressEvent<XMLHttpRequestEventTarget>;  "timeout": ProgressEvent<XMLHttpRequestEventTarget>;}
interface XMLHttpRequestEventMap extends XMLHttpRequestEventTargetEventMap {  "readystatechange": Event;}
interface XMLHttpRequestEventTarget extends EventTarget {  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;  ontimeout: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;  addEventListener<K extends keyof XMLHttpRequestEventTargetEventMap>(    type: K,    listener: (      this: XMLHttpRequestEventTarget,      ev: XMLHttpRequestEventTargetEventMap[K],    ) => any,    options?: boolean | AddEventListenerOptions,  ): void;  addEventListener(    type: string,    listener: EventListenerOrEventListenerObject,    options?: boolean | AddEventListenerOptions,  ): void;  removeEventListener<K extends keyof XMLHttpRequestEventTargetEventMap>(    type: K,    listener: (      this: XMLHttpRequestEventTarget,      ev: XMLHttpRequestEventTargetEventMap[K],    ) => any,    options?: boolean | EventListenerOptions,  ): void;  removeEventListener(    type: string,    listener: EventListenerOrEventListenerObject,    options?: boolean | EventListenerOptions,  ): void;}
/** * The interface for event handlers for {@linkcode XMLHttpRequest} and * {@lincode XMLHttpRequestUpload}. */// deno-lint-ignore no-vardeclare var XMLHttpRequestEventTarget: {  prototype: XMLHttpRequestEventTarget;  new (): XMLHttpRequestEventTarget;};
/** * 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. */interface XMLHttpRequest extends XMLHttpRequestEventTarget {  onreadystatechange: ((this: XMLHttpRequest, ev: Event) => any) | null;  /**   * Returns client's state.   */  readonly readyState: number;  /**   * Returns the response's body.   */  readonly response: any;  /**   * Returns the text response.   *   * Throws an "InvalidStateError" DOMException if responseType is not the empty string or "text".   */  readonly responseText: string;  /**   * 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.   */  responseType: XMLHttpRequestResponseType;  readonly responseURL: string;  /**   * Returns the document response.   *   * Throws an "InvalidStateError" DOMException if responseType is not the empty string or "document".   */  readonly responseXML: null;  readonly status: number;  readonly statusText: string;  /**   * 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.   */  timeout: number;  /**   * Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.   */  readonly upload: XMLHttpRequestUpload;  /**   * 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.   */  withCredentials: boolean;  /**   * Cancels any network activity.   */  abort(): void;  getAllResponseHeaders(): string;  getResponseHeader(name: string): string | null;  /**   * 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.   */  open(method: string, url: string): void;  open(    method: string,    url: string,    async: boolean,    username?: string | null,    password?: string | null,  ): 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.   */  overrideMimeType(mime: string): void;  /**   * 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.   */  send(body?: BodyInit | null): 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.   */  setRequestHeader(name: string, value: string): void;  readonly DONE: number;  readonly HEADERS_RECEIVED: number;  readonly LOADING: number;  readonly OPENED: number;  readonly UNSENT: number;  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;  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;}
/** * 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. * * Despite its name, XMLHttpRequest can be used to retrieve any type of data, * not just XML. */// deno-lint-ignore no-vardeclare var XMLHttpRequest: {  prototype: XMLHttpRequest;  new (): XMLHttpRequest;  readonly DONE: number;  readonly HEADERS_RECEIVED: number;  readonly LOADING: number;  readonly OPENED: number;  readonly UNSENT: number;};
interface XMLHttpRequestUpload extends XMLHttpRequestEventTarget {  addEventListener<K extends keyof XMLHttpRequestEventTargetEventMap>(    type: K,    listener: (      this: XMLHttpRequestUpload,      ev: XMLHttpRequestEventTargetEventMap[K],    ) => any,    options?: boolean | AddEventListenerOptions,  ): void;  addEventListener(    type: string,    listener: EventListenerOrEventListenerObject,    options?: boolean | AddEventListenerOptions,  ): void;  removeEventListener<K extends keyof XMLHttpRequestEventTargetEventMap>(    type: K,    listener: (      this: XMLHttpRequestUpload,      ev: XMLHttpRequestEventTargetEventMap[K],    ) => any,    options?: boolean | EventListenerOptions,  ): void;  removeEventListener(    type: string,    listener: EventListenerOrEventListenerObject,    options?: boolean | EventListenerOptions,  ): void;}
/** * Represents the upload process for a specific {@linkcode XMLHttpRequest}. It * is an _opaque_ object that represents the underlying, runtime-dependent, * upload process. It is an {@linkcode XMLHttpRequestEventTarget} and can be * obtained by calling `XMLHttpRequest.upload`. */// deno-lint-ignore no-vardeclare var XMLHttpRequestUpload: {  prototype: XMLHttpRequestUpload;  new (): XMLHttpRequestUpload;};