Module

x/evt/lib/index.ts

šŸ’§EventEmitter's typesafe replacement
Go to Latest
interface dom.XMLHttpRequest
import { type dom } from "https://deno.land/x/evt@v2.3.1/lib/index.ts";
const { XMLHttpRequest } = dom;

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.

Properties

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

Returns client's state.

readonly
response: any

Returns the response's body.

readonly
responseText: string

Returns the text response.

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

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: string
readonly
responseXML: Document | null

Returns the document response.

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

readonly
status: number
readonly
statusText: string
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: XMLHttpRequestUpload

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

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.

readonly
DONE: number
readonly
HEADERS_RECEIVED: number
readonly
LOADING: number
readonly
OPENED: number
readonly
UNSENT: number

Methods

abort(): void

Cancels any network activity.

getAllResponseHeaders(): string
getResponseHeader(name: string): string | null
open(method: string, url: string): 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.

open(
method: string,
url: string,
async: boolean,
username?: string | null,
password?: string | null,
): void
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.

send(body?: Document | BodyInit | null): 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.

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.

addEventListener<K extends keyof XMLHttpRequestEventMap>(
type: K,
listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): void
addEventListener(
type: string,
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,
options?: boolean | EventListenerOptions,
): void