Interface XMLDocument

An XML document. It inherits from the generic Document and does not add any specific methods or properties to it: nevertheless, several algorithms behave differently with the two types of documents.

MDN Reference

interface XMLDocument {
    activeElement: null | Element;
    adoptedStyleSheets: CSSStyleSheet[];
    alinkColor: string;
    all: HTMLAllCollection;
    anchors: HTMLCollectionOf<HTMLAnchorElement>;
    applets: HTMLCollection;
    ATTRIBUTE_NODE: 2;
    baseURI: string;
    bgColor: string;
    body: HTMLElement;
    CDATA_SECTION_NODE: 4;
    characterSet: string;
    charset: string;
    childElementCount: number;
    childNodes: NodeListOf<ChildNode>;
    children: HTMLCollection;
    COMMENT_NODE: 8;
    compatMode: string;
    contentType: string;
    cookie: string;
    currentScript: null | HTMLOrSVGScriptElement;
    defaultView: null | Window & typeof globalThis;
    designMode: string;
    dir: string;
    doctype: null | DocumentType;
    DOCUMENT_FRAGMENT_NODE: 11;
    DOCUMENT_NODE: 9;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_TYPE_NODE: 10;
    documentElement: HTMLElement;
    documentURI: string;
    domain: string;
    ELEMENT_NODE: 1;
    embeds: HTMLCollectionOf<HTMLEmbedElement>;
    ENTITY_NODE: 6;
    ENTITY_REFERENCE_NODE: 5;
    fgColor: string;
    firstChild: null | ChildNode;
    firstElementChild: null | Element;
    fonts: FontFaceSet;
    forms: HTMLCollectionOf<HTMLFormElement>;
    fragmentDirective: FragmentDirective;
    fullscreen: boolean;
    fullscreenElement: null | Element;
    fullscreenEnabled: boolean;
    head: HTMLHeadElement;
    hidden: boolean;
    images: HTMLCollectionOf<HTMLImageElement>;
    implementation: DOMImplementation;
    inputEncoding: string;
    isConnected: boolean;
    lastChild: null | ChildNode;
    lastElementChild: null | Element;
    lastModified: string;
    linkColor: string;
    links: HTMLCollectionOf<HTMLAnchorElement | HTMLAreaElement>;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    NOTATION_NODE: 12;
    onabort: null | (this: GlobalEventHandlers, ev: UIEvent) => any;
    onanimationcancel:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationend:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationiteration:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onanimationstart:
        | null
        | (this: GlobalEventHandlers, ev: AnimationEvent) => any;
    onauxclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onbeforeinput: null | (this: GlobalEventHandlers, ev: InputEvent) => any;
    onbeforetoggle: null | (this: GlobalEventHandlers, ev: Event) => any;
    onblur: null | (this: GlobalEventHandlers, ev: FocusEvent) => any;
    oncancel: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncanplay: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncanplaythrough: null | (this: GlobalEventHandlers, ev: Event) => any;
    onchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onclose: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncontextlost: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncontextmenu: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    oncontextrestored: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncopy: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    oncuechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    oncut: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    ondblclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    ondrag: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragend: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragenter: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragleave: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragover: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondragstart: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondrop: null | (this: GlobalEventHandlers, ev: DragEvent) => any;
    ondurationchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onemptied: null | (this: GlobalEventHandlers, ev: Event) => any;
    onended: null | (this: GlobalEventHandlers, ev: Event) => any;
    onerror: OnErrorEventHandler;
    onfocus: null | (this: GlobalEventHandlers, ev: FocusEvent) => any;
    onformdata: null | (this: GlobalEventHandlers, ev: FormDataEvent) => any;
    onfullscreenchange: null | (this: Document, ev: Event) => any;
    onfullscreenerror: null | (this: Document, ev: Event) => any;
    ongotpointercapture:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    oninput: null | (this: GlobalEventHandlers, ev: Event) => any;
    oninvalid: null | (this: GlobalEventHandlers, ev: Event) => any;
    onkeydown: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onkeypress: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onkeyup: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
    onload: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadeddata: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadedmetadata: null | (this: GlobalEventHandlers, ev: Event) => any;
    onloadstart: null | (this: GlobalEventHandlers, ev: Event) => any;
    onlostpointercapture:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onmousedown: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseenter: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseleave: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmousemove: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseout: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseover: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onmouseup: null | (this: GlobalEventHandlers, ev: MouseEvent) => any;
    onpaste: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
    onpause: null | (this: GlobalEventHandlers, ev: Event) => any;
    onplay: null | (this: GlobalEventHandlers, ev: Event) => any;
    onplaying: null | (this: GlobalEventHandlers, ev: Event) => any;
    onpointercancel:
        | null
        | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerdown: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerenter: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerleave: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerlockchange: null | (this: Document, ev: Event) => any;
    onpointerlockerror: null | (this: Document, ev: Event) => any;
    onpointermove: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerout: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerover: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onpointerup: null | (this: GlobalEventHandlers, ev: PointerEvent) => any;
    onprogress:
        | null
        | (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
    onratechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onreadystatechange: null | (this: Document, ev: Event) => any;
    onreset: null | (this: GlobalEventHandlers, ev: Event) => any;
    onresize: null | (this: GlobalEventHandlers, ev: UIEvent) => any;
    onscroll: null | (this: GlobalEventHandlers, ev: Event) => any;
    onscrollend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onsecuritypolicyviolation:
        | null
        | (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
    onseeked: null | (this: GlobalEventHandlers, ev: Event) => any;
    onseeking: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselect: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselectionchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onselectstart: null | (this: GlobalEventHandlers, ev: Event) => any;
    onslotchange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onstalled: null | (this: GlobalEventHandlers, ev: Event) => any;
    onsubmit: null | (this: GlobalEventHandlers, ev: SubmitEvent) => any;
    onsuspend: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontimeupdate: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontoggle: null | (this: GlobalEventHandlers, ev: Event) => any;
    ontouchcancel?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchend?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchmove?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontouchstart?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any;
    ontransitioncancel:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionend:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionrun:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    ontransitionstart:
        | null
        | (this: GlobalEventHandlers, ev: TransitionEvent) => any;
    onvisibilitychange: null | (this: Document, ev: Event) => any;
    onvolumechange: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwaiting: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationiteration:
        | null
        | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkitanimationstart:
        | null
        | (this: GlobalEventHandlers, ev: Event) => any;
    onwebkittransitionend: null | (this: GlobalEventHandlers, ev: Event) => any;
    onwheel: null | (this: GlobalEventHandlers, ev: WheelEvent) => any;
    ownerDocument: null;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    pictureInPictureElement: null | Element;
    pictureInPictureEnabled: boolean;
    plugins: HTMLCollectionOf<HTMLEmbedElement>;
    pointerLockElement: null | Element;
    previousSibling: null | ChildNode;
    PROCESSING_INSTRUCTION_NODE: 7;
    readyState: DocumentReadyState;
    referrer: string;
    rootElement: null | SVGSVGElement;
    scripts: HTMLCollectionOf<HTMLScriptElement>;
    scrollingElement: null | Element;
    styleSheets: StyleSheetList;
    TEXT_NODE: 3;
    textContent: null | string;
    timeline: DocumentTimeline;
    title: string;
    URL: string;
    visibilityState: DocumentVisibilityState;
    vlinkColor: string;
    get location(): Location;
    set location(href: string | Location): void;
    addEventListener<K extends keyof DocumentEventMap>(
        type: K,
        listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    adoptNode<T extends Node>(node: T): T;
    append(...nodes: (string | Node)[]): void;
    appendChild<T extends Node>(node: T): T;
    captureEvents(): void;
    caretPositionFromPoint(
        x: number,
        y: number,
        options?: CaretPositionFromPointOptions,
    ): null | CaretPosition;
    caretRangeFromPoint(x: number, y: number): null | Range;
    clear(): void;
    cloneNode(deep?: boolean): Node;
    close(): void;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    createAttribute(localName: string): Attr;
    createAttributeNS(namespace: null | string, qualifiedName: string): Attr;
    createCDATASection(data: string): CDATASection;
    createComment(data: string): Comment;
    createDocumentFragment(): DocumentFragment;
    createElement<K extends keyof HTMLElementTagNameMap>(
        tagName: K,
        options?: ElementCreationOptions,
    ): HTMLElementTagNameMap[K];
    createElement<K extends keyof HTMLElementDeprecatedTagNameMap>(
        tagName: K,
        options?: ElementCreationOptions,
    ): HTMLElementDeprecatedTagNameMap[K];
    createElement(
        tagName: string,
        options?: ElementCreationOptions,
    ): HTMLElement;
    createElementNS(
        namespaceURI: "http://www.w3.org/1999/xhtml",
        qualifiedName: string,
    ): HTMLElement;
    createElementNS<K extends keyof SVGElementTagNameMap>(
        namespaceURI: "http://www.w3.org/2000/svg",
        qualifiedName: K,
    ): SVGElementTagNameMap[K];
    createElementNS(
        namespaceURI: "http://www.w3.org/2000/svg",
        qualifiedName: string,
    ): SVGElement;
    createElementNS<K extends keyof MathMLElementTagNameMap>(
        namespaceURI: "http://www.w3.org/1998/Math/MathML",
        qualifiedName: K,
    ): MathMLElementTagNameMap[K];
    createElementNS(
        namespaceURI: "http://www.w3.org/1998/Math/MathML",
        qualifiedName: string,
    ): MathMLElement;
    createElementNS(
        namespaceURI: null | string,
        qualifiedName: string,
        options?: ElementCreationOptions,
    ): Element;
    createElementNS(
        namespace: null | string,
        qualifiedName: string,
        options?: string | ElementCreationOptions,
    ): Element;
    createEvent(eventInterface: "AnimationEvent"): AnimationEvent;
    createEvent(
        eventInterface: "AnimationPlaybackEvent",
    ): AnimationPlaybackEvent;
    createEvent(eventInterface: "AudioProcessingEvent"): AudioProcessingEvent;
    createEvent(eventInterface: "BeforeUnloadEvent"): BeforeUnloadEvent;
    createEvent(eventInterface: "BlobEvent"): BlobEvent;
    createEvent(eventInterface: "ClipboardEvent"): ClipboardEvent;
    createEvent(eventInterface: "CloseEvent"): CloseEvent;
    createEvent(eventInterface: "CompositionEvent"): CompositionEvent;
    createEvent(
        eventInterface: "ContentVisibilityAutoStateChangeEvent",
    ): ContentVisibilityAutoStateChangeEvent;
    createEvent(eventInterface: "CustomEvent"): CustomEvent<any>;
    createEvent(eventInterface: "DeviceMotionEvent"): DeviceMotionEvent;
    createEvent(
        eventInterface: "DeviceOrientationEvent",
    ): DeviceOrientationEvent;
    createEvent(eventInterface: "DragEvent"): DragEvent;
    createEvent(eventInterface: "ErrorEvent"): ErrorEvent;
    createEvent(eventInterface: "Event"): Event;
    createEvent(eventInterface: "Events"): Event;
    createEvent(eventInterface: "FocusEvent"): FocusEvent;
    createEvent(eventInterface: "FontFaceSetLoadEvent"): FontFaceSetLoadEvent;
    createEvent(eventInterface: "FormDataEvent"): FormDataEvent;
    createEvent(eventInterface: "GamepadEvent"): GamepadEvent;
    createEvent(eventInterface: "HashChangeEvent"): HashChangeEvent;
    createEvent(eventInterface: "IDBVersionChangeEvent"): IDBVersionChangeEvent;
    createEvent(eventInterface: "InputEvent"): InputEvent;
    createEvent(eventInterface: "KeyboardEvent"): KeyboardEvent;
    createEvent(eventInterface: "MIDIConnectionEvent"): MIDIConnectionEvent;
    createEvent(eventInterface: "MIDIMessageEvent"): MIDIMessageEvent;
    createEvent(eventInterface: "MediaEncryptedEvent"): MediaEncryptedEvent;
    createEvent(eventInterface: "MediaKeyMessageEvent"): MediaKeyMessageEvent;
    createEvent(eventInterface: "MediaQueryListEvent"): MediaQueryListEvent;
    createEvent(eventInterface: "MediaStreamTrackEvent"): MediaStreamTrackEvent;
    createEvent(eventInterface: "MessageEvent"): MessageEvent<any>;
    createEvent(eventInterface: "MouseEvent"): MouseEvent;
    createEvent(eventInterface: "MouseEvents"): MouseEvent;
    createEvent(
        eventInterface: "OfflineAudioCompletionEvent",
    ): OfflineAudioCompletionEvent;
    createEvent(eventInterface: "PageTransitionEvent"): PageTransitionEvent;
    createEvent(
        eventInterface: "PaymentMethodChangeEvent",
    ): PaymentMethodChangeEvent;
    createEvent(
        eventInterface: "PaymentRequestUpdateEvent",
    ): PaymentRequestUpdateEvent;
    createEvent(eventInterface: "PictureInPictureEvent"): PictureInPictureEvent;
    createEvent(eventInterface: "PointerEvent"): PointerEvent;
    createEvent(eventInterface: "PopStateEvent"): PopStateEvent;
    createEvent(eventInterface: "ProgressEvent"): ProgressEvent<EventTarget>;
    createEvent(eventInterface: "PromiseRejectionEvent"): PromiseRejectionEvent;
    createEvent(
        eventInterface: "RTCDTMFToneChangeEvent",
    ): RTCDTMFToneChangeEvent;
    createEvent(eventInterface: "RTCDataChannelEvent"): RTCDataChannelEvent;
    createEvent(eventInterface: "RTCErrorEvent"): RTCErrorEvent;
    createEvent(
        eventInterface: "RTCPeerConnectionIceErrorEvent",
    ): RTCPeerConnectionIceErrorEvent;
    createEvent(
        eventInterface: "RTCPeerConnectionIceEvent",
    ): RTCPeerConnectionIceEvent;
    createEvent(eventInterface: "RTCTrackEvent"): RTCTrackEvent;
    createEvent(
        eventInterface: "SecurityPolicyViolationEvent",
    ): SecurityPolicyViolationEvent;
    createEvent(
        eventInterface: "SpeechSynthesisErrorEvent",
    ): SpeechSynthesisErrorEvent;
    createEvent(eventInterface: "SpeechSynthesisEvent"): SpeechSynthesisEvent;
    createEvent(eventInterface: "StorageEvent"): StorageEvent;
    createEvent(eventInterface: "SubmitEvent"): SubmitEvent;
    createEvent(eventInterface: "TextEvent"): TextEvent;
    createEvent(eventInterface: "ToggleEvent"): ToggleEvent;
    createEvent(eventInterface: "TouchEvent"): TouchEvent;
    createEvent(eventInterface: "TrackEvent"): TrackEvent;
    createEvent(eventInterface: "TransitionEvent"): TransitionEvent;
    createEvent(eventInterface: "UIEvent"): UIEvent;
    createEvent(eventInterface: "UIEvents"): UIEvent;
    createEvent(eventInterface: "WebGLContextEvent"): WebGLContextEvent;
    createEvent(eventInterface: "WheelEvent"): WheelEvent;
    createEvent(eventInterface: string): Event;
    createExpression(
        expression: string,
        resolver?: null | XPathNSResolver,
    ): XPathExpression;
    createNodeIterator(
        root: Node,
        whatToShow?: number,
        filter?: null | NodeFilter,
    ): NodeIterator;
    createNSResolver(nodeResolver: Node): Node;
    createProcessingInstruction(
        target: string,
        data: string,
    ): ProcessingInstruction;
    createRange(): Range;
    createTextNode(data: string): Text;
    createTreeWalker(
        root: Node,
        whatToShow?: number,
        filter?: null | NodeFilter,
    ): TreeWalker;
    dispatchEvent(event: Event): boolean;
    elementFromPoint(x: number, y: number): null | Element;
    elementsFromPoint(x: number, y: number): Element[];
    evaluate(
        expression: string,
        contextNode: Node,
        resolver?: null | XPathNSResolver,
        type?: number,
        result?: null | XPathResult,
    ): XPathResult;
    execCommand(commandId: string, showUI?: boolean, value?: string): boolean;
    exitFullscreen(): Promise<void>;
    exitPictureInPicture(): Promise<void>;
    exitPointerLock(): void;
    getAnimations(): Animation[];
    getElementById(elementId: string): null | HTMLElement;
    getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
    getElementsByName(elementName: string): NodeListOf<HTMLElement>;
    getElementsByTagName<K extends keyof HTMLElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
    getElementsByTagName<K extends keyof SVGElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<SVGElementTagNameMap[K]>;
    getElementsByTagName<K extends keyof MathMLElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
    getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
    getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
    getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1999/xhtml",
        localName: string,
    ): HTMLCollectionOf<HTMLElement>;
    getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/2000/svg",
        localName: string,
    ): HTMLCollectionOf<SVGElement>;
    getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1998/Math/MathML",
        localName: string,
    ): HTMLCollectionOf<MathMLElement>;
    getElementsByTagNameNS(
        namespace: null | string,
        localName: string,
    ): HTMLCollectionOf<Element>;
    getRootNode(options?: GetRootNodeOptions): Node;
    getSelection(): null | Selection;
    hasChildNodes(): boolean;
    hasFocus(): boolean;
    hasStorageAccess(): Promise<boolean>;
    importNode<T extends Node>(node: T, deep?: boolean): T;
    insertBefore<T extends Node>(node: T, child: null | Node): T;
    isDefaultNamespace(namespace: null | string): boolean;
    isEqualNode(otherNode: null | Node): boolean;
    isSameNode(otherNode: null | Node): boolean;
    lookupNamespaceURI(prefix: null | string): null | string;
    lookupPrefix(namespace: null | string): null | string;
    normalize(): void;
    open(unused1?: string, unused2?: string): Document;
    open(url: string | URL, name: string, features: string): null | Window;
    prepend(...nodes: (string | Node)[]): void;
    queryCommandEnabled(commandId: string): boolean;
    queryCommandIndeterm(commandId: string): boolean;
    queryCommandState(commandId: string): boolean;
    queryCommandSupported(commandId: string): boolean;
    queryCommandValue(commandId: string): string;
    querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K];
    querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K];
    querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K];
    querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E extends Element = Element>(selectors: string): null | E;
    querySelectorAll<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): NodeListOf<SVGElementTagNameMap[K]>;
    querySelectorAll<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<MathMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
    querySelectorAll<E extends Element = Element>(
        selectors: string,
    ): NodeListOf<E>;
    releaseEvents(): void;
    removeChild<T extends Node>(child: T): T;
    removeEventListener<K extends keyof DocumentEventMap>(
        type: K,
        listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    replaceChild<T extends Node>(node: Node, child: T): T;
    replaceChildren(...nodes: (string | Node)[]): void;
    requestStorageAccess(): Promise<void>;
    startViewTransition(
        callbackOptions?: ViewTransitionUpdateCallback,
    ): ViewTransition;
    write(...text: string[]): void;
    writeln(...text: string[]): void;
}

Hierarchy (View Summary)

Document
- XMLDocument

Index

Properties

`Readonly`activeElement

activeElement: null | Element

Returns the deepest element in the document through which or to which key events are being routed. This is, roughly speaking, the focused element in the document.

For the purposes of this API, when a child browsing context is focused, its container is focused in the parent browsing context. For example, if the user moves the focus to a text control in an iframe, the iframe is the element returned by the activeElement API in the iframe's node document.

Similarly, when the focused element is in a different node tree than documentOrShadowRoot, the element returned will be the host that's located in the same node tree as documentOrShadowRoot if documentOrShadowRoot is a shadow-including inclusive ancestor of the focused element, and null if not.

MDN Reference

adoptedStyleSheets

adoptedStyleSheets: CSSStyleSheet[]

MDN Reference

alinkColor

alinkColor: string

Sets or gets the color of all active links in the document.

Deprecated

MDN Reference

`Readonly`all

all: HTMLAllCollection

Returns a reference to the collection of elements contained by the object.

Deprecated

MDN Reference

`Readonly`anchors

anchors: HTMLCollectionOf<HTMLAnchorElement>

Retrieves a collection of all a objects that have a name and/or id property. Objects in this collection are in HTML source order.

Deprecated

MDN Reference

`Readonly`applets

applets: HTMLCollection

Retrieves a collection of all applet objects in the document.

Deprecated

MDN Reference

`Readonly`ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

`Readonly`baseURI

baseURI: string

Returns node's node document's document base URL.

MDN Reference

bgColor

bgColor: string

Deprecated. Sets or retrieves a value that indicates the background color behind the object.

Deprecated

MDN Reference

body

body: HTMLElement

Specifies the beginning and end of the document body.

MDN Reference

`Readonly`CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly`characterSet

characterSet: string

Returns document's encoding.

MDN Reference

`Readonly`charset

charset: string

Gets or sets the character set used to encode the object.

Deprecated

This is a legacy alias of characterSet.

MDN Reference

`Readonly`childElementCount

childElementCount: number

MDN Reference

`Readonly`childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

`Readonly`children

children: HTMLCollection

Returns the child elements.

MDN Reference

`Readonly`COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

`Readonly`compatMode

compatMode: string

Gets a value that indicates whether standards-compliant mode is switched on for the object.

MDN Reference

`Readonly`contentType

contentType: string

Returns document's content type.

MDN Reference

cookie

cookie: string

Returns the HTTP cookies that apply to the Document. If there are no cookies or cookies can't be applied to this resource, the empty string will be returned.

Can be set, to add a new cookie to the element's set of HTTP cookies.

If the contents are sandboxed into a unique origin (e.g. in an iframe with the sandbox attribute), a "SecurityError" DOMException will be thrown on getting and setting.

MDN Reference

`Readonly`currentScript

currentScript: null | HTMLOrSVGScriptElement

Returns the script element, or the SVG script element, that is currently executing, as long as the element represents a classic script. In the case of reentrant script execution, returns the one that most recently started executing amongst those that have not yet finished executing.

Returns null if the Document is not currently executing a script or SVG script element (e.g., because the running script is an event handler, or a timeout), or if the currently executing script or SVG script element represents a module script.

MDN Reference

`Readonly`defaultView

defaultView: null | Window & typeof globalThis

Returns the Window object of the active document.

MDN Reference

designMode

designMode: string

Sets or gets a value that indicates whether the document can be edited.

MDN Reference

dir

dir: string

Sets or retrieves a value that indicates the reading order of the object.

MDN Reference

`Readonly`doctype

doctype: null | DocumentType

Gets an object representing the document type declaration associated with the current document.

MDN Reference

`Readonly`DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

`Readonly`DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

`Readonly`DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

`Readonly`DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

`Readonly`DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

`Readonly`DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

`Readonly`DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

`Readonly`documentElement

documentElement: HTMLElement

Gets a reference to the root node of the document.

MDN Reference

`Readonly`documentURI

documentURI: string

Returns document's URL.

MDN Reference

domain

domain: string

Sets or gets the security domain of the document.

Deprecated

MDN Reference

`Readonly`ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

`Readonly`embeds

embeds: HTMLCollectionOf<HTMLEmbedElement>

Retrieves a collection of all embed objects in the document.

MDN Reference

`Readonly`ENTITY_NODE

ENTITY_NODE: 6

`Readonly`ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

fgColor

fgColor: string

Sets or gets the foreground (text) color of the document.

Deprecated

MDN Reference

`Readonly`firstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

`Readonly`firstElementChild

firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

MDN Reference

`Readonly`fonts

fonts: FontFaceSet

MDN Reference

`Readonly`forms

forms: HTMLCollectionOf<HTMLFormElement>

Retrieves a collection, in source order, of all form objects in the document.

MDN Reference

`Readonly`fragmentDirective

fragmentDirective: FragmentDirective

MDN Reference

`Readonly`fullscreen

fullscreen: boolean

Deprecated

MDN Reference

`Readonly`fullscreenElement

fullscreenElement: null | Element

Returns document's fullscreen element.

MDN Reference

`Readonly`fullscreenEnabled

fullscreenEnabled: boolean

Returns true if document has the ability to display elements fullscreen and fullscreen is supported, or false otherwise.

MDN Reference

`Readonly`head

head: HTMLHeadElement

Returns the head element.

MDN Reference

`Readonly`hidden

hidden: boolean

MDN Reference

`Readonly`images

images: HTMLCollectionOf<HTMLImageElement>

Retrieves a collection, in source order, of img objects in the document.

MDN Reference

`Readonly`implementation

implementation: DOMImplementation

Gets the implementation object of the current document.

MDN Reference

`Readonly`inputEncoding

inputEncoding: string

Returns the character encoding used to create the webpage that is loaded into the document object.

Deprecated

This is a legacy alias of characterSet.

MDN Reference

`Readonly`isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

`Readonly`lastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

`Readonly`lastElementChild

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

MDN Reference

`Readonly`lastModified

lastModified: string

Gets the date that the page was last modified, if the page supplies one.

MDN Reference

linkColor

linkColor: string

Sets or gets the color of the document links.

Deprecated

MDN Reference

`Readonly`links

links: HTMLCollectionOf<HTMLAnchorElement | HTMLAreaElement>

Retrieves a collection of all a objects that specify the href property and all area objects in the document.

MDN Reference

`Readonly`nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

`Readonly`nodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

`Readonly`nodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

`Readonly`NOTATION_NODE

NOTATION_NODE: 12

onabort

onabort: null | (this: GlobalEventHandlers, ev: UIEvent) => any

Fires when the user aborts the download.

Param: ev

The event.

MDN Reference

onanimationcancel

onanimationcancel: null | (this: GlobalEventHandlers, ev: AnimationEvent) => any

MDN Reference

onanimationend

onanimationend: null | (this: GlobalEventHandlers, ev: AnimationEvent) => any

MDN Reference

onanimationiteration

onanimationiteration:
| null
| (this: GlobalEventHandlers, ev: AnimationEvent) => any

MDN Reference

onanimationstart

onanimationstart: null | (this: GlobalEventHandlers, ev: AnimationEvent) => any

MDN Reference

onauxclick

onauxclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

MDN Reference

onbeforeinput

onbeforeinput: null | (this: GlobalEventHandlers, ev: InputEvent) => any

MDN Reference

onbeforetoggle

onbeforetoggle: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onblur

onblur: null | (this: GlobalEventHandlers, ev: FocusEvent) => any

Fires when the object loses the input focus.

Param: ev

The focus event.

MDN Reference

oncancel

oncancel: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

oncanplay

oncanplay: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when playback is possible, but would require further buffering.

Param: ev

The event.

MDN Reference

oncanplaythrough

oncanplaythrough: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onchange

onchange: null | (this: GlobalEventHandlers, ev: Event) => any

Fires when the contents of the object or selection have changed.

Param: ev

The event.

MDN Reference

onclick

onclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user clicks the left mouse button on the object

Param: ev

The mouse event.

MDN Reference

onclose

onclose: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

oncontextlost

oncontextlost: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

oncontextmenu

oncontextmenu: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Param: ev

The mouse event.

MDN Reference

oncontextrestored

oncontextrestored: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

oncopy

oncopy: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any

MDN Reference

oncuechange

oncuechange: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

oncut

oncut: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any

MDN Reference

ondblclick

ondblclick: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user double-clicks the object.

Param: ev

The mouse event.

MDN Reference

ondrag

ondrag: null | (this: GlobalEventHandlers, ev: DragEvent) => any

Fires on the source object continuously during a drag operation.

Param: ev

The event.

MDN Reference

ondragend

ondragend: null | (this: GlobalEventHandlers, ev: DragEvent) => any

Fires on the source object when the user releases the mouse at the close of a drag operation.

Param: ev

The event.

MDN Reference

ondragenter

ondragenter: null | (this: GlobalEventHandlers, ev: DragEvent) => any

Fires on the target element when the user drags the object to a valid drop target.

Param: ev

The drag event.

MDN Reference

ondragleave

ondragleave: null | (this: GlobalEventHandlers, ev: DragEvent) => any

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Param: ev

The drag event.

MDN Reference

ondragover

ondragover: null | (this: GlobalEventHandlers, ev: DragEvent) => any

Fires on the target element continuously while the user drags the object over a valid drop target.

Param: ev

The event.

MDN Reference

ondragstart

ondragstart: null | (this: GlobalEventHandlers, ev: DragEvent) => any

Fires on the source object when the user starts to drag a text selection or selected object.

Param: ev

The event.

MDN Reference

ondrop

ondrop: null | (this: GlobalEventHandlers, ev: DragEvent) => any

MDN Reference

ondurationchange

ondurationchange: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the duration attribute is updated.

Param: ev

The event.

MDN Reference

onemptied

onemptied: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the media element is reset to its initial state.

Param: ev

The event.

MDN Reference

onended

onended: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the end of playback is reached.

Param: ev

The event

MDN Reference

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus

onfocus: null | (this: GlobalEventHandlers, ev: FocusEvent) => any

Fires when the object receives focus.

Param: ev

The event.

MDN Reference

onformdata

onformdata: null | (this: GlobalEventHandlers, ev: FormDataEvent) => any

MDN Reference

onfullscreenchange

onfullscreenchange: null | (this: Document, ev: Event) => any

MDN Reference

onfullscreenerror

onfullscreenerror: null | (this: Document, ev: Event) => any

MDN Reference

ongotpointercapture

ongotpointercapture: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

oninput

oninput: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

oninvalid

oninvalid: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onkeydown

onkeydown: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any

Fires when the user presses a key.

Param: ev

The keyboard event

MDN Reference

onkeypress

onkeypress: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any

Fires when the user presses an alphanumeric key.

Param: ev

The event.

Deprecated

MDN Reference

onkeyup

onkeyup: null | (this: GlobalEventHandlers, ev: KeyboardEvent) => any

Fires when the user releases a key.

Param: ev

The keyboard event

MDN Reference

onload

onload: null | (this: GlobalEventHandlers, ev: Event) => any

Fires immediately after the browser loads the object.

Param: ev

The event.

MDN Reference

onloadeddata

onloadeddata: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when media data is loaded at the current playback position.

Param: ev

The event.

MDN Reference

onloadedmetadata

onloadedmetadata: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the duration and dimensions of the media have been determined.

Param: ev

The event.

MDN Reference

onloadstart

onloadstart: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when Internet Explorer begins looking for media data.

Param: ev

The event.

MDN Reference

onlostpointercapture

onlostpointercapture:
| null
| (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onmousedown

onmousedown: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user clicks the object with either mouse button.

Param: ev

The mouse event.

MDN Reference

onmouseenter

onmouseenter: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

MDN Reference

onmouseleave

onmouseleave: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

MDN Reference

onmousemove

onmousemove: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user moves the mouse over the object.

Param: ev

The mouse event.

MDN Reference

onmouseout

onmouseout: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user moves the mouse pointer outside the boundaries of the object.

Param: ev

The mouse event.

MDN Reference

onmouseover

onmouseover: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user moves the mouse pointer into the object.

Param: ev

The mouse event.

MDN Reference

onmouseup

onmouseup: null | (this: GlobalEventHandlers, ev: MouseEvent) => any

Fires when the user releases a mouse button while the mouse is over the object.

Param: ev

The mouse event.

MDN Reference

onpaste

onpaste: null | (this: GlobalEventHandlers, ev: ClipboardEvent) => any

MDN Reference

onpause

onpause: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when playback is paused.

Param: ev

The event.

MDN Reference

onplay

onplay: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the play method is requested.

Param: ev

The event.

MDN Reference

onplaying

onplaying: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the audio or video has started playing.

Param: ev

The event.

MDN Reference

onpointercancel

onpointercancel: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerdown

onpointerdown: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerenter

onpointerenter: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerleave

onpointerleave: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerlockchange

onpointerlockchange: null | (this: Document, ev: Event) => any

MDN Reference

onpointerlockerror

onpointerlockerror: null | (this: Document, ev: Event) => any

MDN Reference

onpointermove

onpointermove: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerout

onpointerout: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerover

onpointerover: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onpointerup

onpointerup: null | (this: GlobalEventHandlers, ev: PointerEvent) => any

MDN Reference

onprogress

onprogress:
| null
| (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any

Occurs to indicate progress while downloading media data.

Param: ev

The event.

MDN Reference

onratechange

onratechange: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the playback rate is increased or decreased.

Param: ev

The event.

MDN Reference

onreadystatechange

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

Fires when the state of the object has changed.

Param: ev

The event

MDN Reference

onreset

onreset: null | (this: GlobalEventHandlers, ev: Event) => any

Fires when the user resets a form.

Param: ev

The event.

MDN Reference

onresize

onresize: null | (this: GlobalEventHandlers, ev: UIEvent) => any

MDN Reference

onscroll

onscroll: null | (this: GlobalEventHandlers, ev: Event) => any

Fires when the user repositions the scroll box in the scroll bar on the object.

Param: ev

The event.

MDN Reference

onscrollend

onscrollend: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onsecuritypolicyviolation

onsecuritypolicyviolation:
| null
| (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any

MDN Reference

onseeked

onseeked: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the seek operation ends.

Param: ev

The event.

MDN Reference

onseeking

onseeking: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the current playback position is moved.

Param: ev

The event.

MDN Reference

onselect

onselect: null | (this: GlobalEventHandlers, ev: Event) => any

Fires when the current selection changes.

Param: ev

The event.

MDN Reference

onselectionchange

onselectionchange: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onselectstart

onselectstart: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onslotchange

onslotchange: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

onstalled

onstalled: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the download has stopped.

Param: ev

The event.

MDN Reference

onsubmit

onsubmit: null | (this: GlobalEventHandlers, ev: SubmitEvent) => any

MDN Reference

onsuspend

onsuspend: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs if the load operation has been intentionally halted.

Param: ev

The event.

MDN Reference

ontimeupdate

ontimeupdate: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs to indicate the current playback position.

Param: ev

The event.

MDN Reference

ontoggle

ontoggle: null | (this: GlobalEventHandlers, ev: Event) => any

MDN Reference

`Optional`ontouchcancel

ontouchcancel?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any

MDN Reference

`Optional`ontouchend

ontouchend?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any

MDN Reference

`Optional`ontouchmove

ontouchmove?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any

MDN Reference

`Optional`ontouchstart

ontouchstart?: null | (this: GlobalEventHandlers, ev: TouchEvent) => any

MDN Reference

ontransitioncancel

ontransitioncancel:
| null
| (this: GlobalEventHandlers, ev: TransitionEvent) => any

MDN Reference

ontransitionend

ontransitionend: null | (this: GlobalEventHandlers, ev: TransitionEvent) => any

MDN Reference

ontransitionrun

ontransitionrun: null | (this: GlobalEventHandlers, ev: TransitionEvent) => any

MDN Reference

ontransitionstart

ontransitionstart:
| null
| (this: GlobalEventHandlers, ev: TransitionEvent) => any

MDN Reference

onvisibilitychange

onvisibilitychange: null | (this: Document, ev: Event) => any

MDN Reference

onvolumechange

onvolumechange: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when the volume is changed, or playback is muted or unmuted.

Param: ev

The event.

MDN Reference

onwaiting

onwaiting: null | (this: GlobalEventHandlers, ev: Event) => any

Occurs when playback stops because the next frame of a video resource is not available.

Param: ev

The event.

MDN Reference

onwebkitanimationend

onwebkitanimationend: null | (this: GlobalEventHandlers, ev: Event) => any

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

onwebkitanimationiteration: null | (this: GlobalEventHandlers, ev: Event) => any

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

onwebkitanimationstart: null | (this: GlobalEventHandlers, ev: Event) => any

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

onwebkittransitionend: null | (this: GlobalEventHandlers, ev: Event) => any

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

onwheel: null | (this: GlobalEventHandlers, ev: WheelEvent) => any

MDN Reference

`Readonly`ownerDocument

ownerDocument: null

Returns the node document. Returns null for documents.

MDN Reference

`Readonly`parentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

`Readonly`parentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

`Readonly`pictureInPictureElement

pictureInPictureElement: null | Element

MDN Reference

`Readonly`pictureInPictureEnabled

pictureInPictureEnabled: boolean

MDN Reference

`Readonly`plugins

plugins: HTMLCollectionOf<HTMLEmbedElement>

Return an HTMLCollection of the embed elements in the Document.

MDN Reference

`Readonly`pointerLockElement

pointerLockElement: null | Element

MDN Reference

`Readonly`previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

`Readonly`PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

`Readonly`readyState

readyState: DocumentReadyState

Retrieves a value that indicates the current state of the object.

MDN Reference

`Readonly`referrer

referrer: string

Gets the URL of the location that referred the user to the current page.

MDN Reference

`Readonly`rootElement

rootElement: null | SVGSVGElement

Deprecated

MDN Reference

`Readonly`scripts

scripts: HTMLCollectionOf<HTMLScriptElement>

Retrieves a collection of all script objects in the document.

MDN Reference

`Readonly`scrollingElement

scrollingElement: null | Element

MDN Reference

`Readonly`styleSheets

styleSheets: StyleSheetList

Retrieves a collection of styleSheet objects representing the style sheets that correspond to each instance of a link or style object in the document.

MDN Reference

`Readonly`TEXT_NODE

TEXT_NODE: 3

node is a Text node.

textContent

textContent: null | string

MDN Reference

`Readonly`timeline

timeline: DocumentTimeline

MDN Reference

title

title: string

Contains the title of the document.

MDN Reference

`Readonly`URL

URL: string

Sets or gets the URL for the current document.

MDN Reference

`Readonly`visibilityState

visibilityState: DocumentVisibilityState

MDN Reference

vlinkColor

vlinkColor: string

Sets or gets the color of the links that the user has visited.

Deprecated

MDN Reference

Accessors

location

get location(): Location
Contains information about the current URL.

MDN Reference

Returns Location
Inherited from Document.location
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7429
set location(href: string | Location): void
Parameters
- href: string | Location
Returns void
Inherited from Document.location
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7430

Methods

addEventListener

addEventListener<K extends keyof DocumentEventMap>(
    type: K,
    listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- K extends keyof DocumentEventMap
Parameters
- type: K
- listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides Document.addEventListener
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:26811
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides Document.addEventListener
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:26812

adoptNode

adoptNode<T extends Node>(node: T): T
Moves node from another document and returns it.

If node is a document, throws a "NotSupportedError" DOMException or, if node is a shadow root, throws a "HierarchyRequestError" DOMException.

MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
Returns T
Inherited from Document.adoptNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7507

append

append(...nodes: (string | Node)[]): void
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- ...nodes: (string | Node)[]
Returns void
Inherited from Document.append
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17307

appendChild

appendChild<T extends Node>(node: T): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
Returns T
Inherited from Document.appendChild
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16659

captureEvents

captureEvents(): void
Returns void
Deprecated
Inherited from Document.captureEvents
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7509

caretPositionFromPoint

caretPositionFromPoint(
    x: number,
    y: number,
    options?: CaretPositionFromPointOptions,
): null | CaretPosition
MDN Reference
Parameters
- x: number
- y: number
- Optionaloptions: CaretPositionFromPointOptions
Returns null | CaretPosition
Inherited from Document.caretPositionFromPoint
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7511

caretRangeFromPoint

caretRangeFromPoint(x: number, y: number): null | Range
Parameters
- x: number
- y: number
Returns null | Range
Deprecated
Inherited from Document.caretRangeFromPoint
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7513

clear

clear(): void
Returns void
Deprecated
MDN Reference
Inherited from Document.clear
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7519

cloneNode

cloneNode(deep?: boolean): Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.

MDN Reference
Parameters
- Optionaldeep: boolean
Returns Node
Inherited from Document.cloneNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16665

close

close(): void
Closes an output stream and forces the sent data to display.

MDN Reference

Returns void
Inherited from Document.close
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7525

compareDocumentPosition

compareDocumentPosition(other: Node): number
Returns a bitmask indicating the position of other relative to node.

MDN Reference
Parameters
- other: Node
Returns number
Inherited from Document.compareDocumentPosition
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16671

contains

contains(other: null | Node): boolean
Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference
Parameters
- other: null | Node
Returns boolean
Inherited from Document.contains
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16677

createAttribute

createAttribute(localName: string): Attr
Creates an attribute object with a specified name.
Parameters
- localName: string
Returns Attr
Inherited from Document.createAttribute
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7532

createAttributeNS

createAttributeNS(namespace: null | string, qualifiedName: string): Attr
MDN Reference
Parameters
- namespace: null | string
- qualifiedName: string
Returns Attr
Inherited from Document.createAttributeNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7534

createCDATASection

createCDATASection(data: string): CDATASection
Returns a CDATASection node whose data is data.

MDN Reference
Parameters
- data: string
Returns CDATASection
Inherited from Document.createCDATASection
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7540

createComment

createComment(data: string): Comment
Creates a comment object with the specified data.
Parameters
- data: string
  Sets the comment object's data.
  
  MDN Reference
Returns Comment
Inherited from Document.createComment
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7547

createDocumentFragment

createDocumentFragment(): DocumentFragment
Creates a new document.

MDN Reference

Returns DocumentFragment
Inherited from Document.createDocumentFragment
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7553

createElement

createElement<K extends keyof HTMLElementTagNameMap>(
tagName: K,
options?: ElementCreationOptions,
): HTMLElementTagNameMap[K]
Creates an instance of the element for the specified tag.
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- tagName: K
  The name of an element.
  
  MDN Reference
- Optionaloptions: ElementCreationOptions
Returns HTMLElementTagNameMap[K]
Inherited from Document.createElement
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7560
createElement<K extends keyof HTMLElementDeprecatedTagNameMap>(
tagName: K,
options?: ElementCreationOptions,
): HTMLElementDeprecatedTagNameMap[K]
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- tagName: K
- Optionaloptions: ElementCreationOptions
Returns HTMLElementDeprecatedTagNameMap[K]
Deprecated
Inherited from Document.createElement
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7562
createElement(tagName: string, options?: ElementCreationOptions): HTMLElement
Parameters
- tagName: string
- Optionaloptions: ElementCreationOptions
Returns HTMLElement
Inherited from Document.createElement
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7563

createElementNS

createElementNS(
namespaceURI: "http://www.w3.org/1999/xhtml",
qualifiedName: string,
): HTMLElement
Returns an element with namespace namespace. Its namespace prefix will be everything before ":" (U+003E) in qualifiedName or null. Its local name will be everything after ":" (U+003E) in qualifiedName or qualifiedName.

If localName does not match the Name production an "InvalidCharacterError" DOMException will be thrown.

If one of the following conditions is true a "NamespaceError" DOMException will be thrown:

localName does not match the QName production. Namespace prefix is not null and namespace is the empty string. Namespace prefix is "xml" and namespace is not the XML namespace. qualifiedName or namespace prefix is "xmlns" and namespace is not the XMLNS namespace. namespace is the XMLNS namespace and neither qualifiedName nor namespace prefix is "xmlns".

When supplied, options's is can be used to create a customized built-in element.

MDN Reference
Parameters
- namespaceURI: "http://www.w3.org/1999/xhtml"
- qualifiedName: string
Returns HTMLElement
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7581
createElementNS<K extends keyof SVGElementTagNameMap>(
namespaceURI: "http://www.w3.org/2000/svg",
qualifiedName: K,
): SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- qualifiedName: K
Returns SVGElementTagNameMap[K]
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7582
createElementNS(
namespaceURI: "http://www.w3.org/2000/svg",
qualifiedName: string,
): SVGElement
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- qualifiedName: string
Returns SVGElement
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7583
createElementNS<K extends keyof MathMLElementTagNameMap>(
namespaceURI: "http://www.w3.org/1998/Math/MathML",
qualifiedName: K,
): MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- namespaceURI: "http://www.w3.org/1998/Math/MathML"
- qualifiedName: K
Returns MathMLElementTagNameMap[K]
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7584
createElementNS(
namespaceURI: "http://www.w3.org/1998/Math/MathML",
qualifiedName: string,
): MathMLElement
Parameters
- namespaceURI: "http://www.w3.org/1998/Math/MathML"
- qualifiedName: string
Returns MathMLElement
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7585
createElementNS(
    namespaceURI: null | string,
    qualifiedName: string,
    options?: ElementCreationOptions,
): Element
Parameters
- namespaceURI: null | string
- qualifiedName: string
- Optionaloptions: ElementCreationOptions
Returns Element
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7586
createElementNS(
    namespace: null | string,
    qualifiedName: string,
    options?: string | ElementCreationOptions,
): Element
Parameters
- namespace: null | string
- qualifiedName: string
- Optionaloptions: string | ElementCreationOptions
Returns Element
Inherited from Document.createElementNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7587

createEvent

createEvent(eventInterface: "AnimationEvent"): AnimationEvent
MDN Reference
Parameters
- eventInterface: "AnimationEvent"
Returns AnimationEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7589
createEvent(eventInterface: "AnimationPlaybackEvent"): AnimationPlaybackEvent
Parameters
- eventInterface: "AnimationPlaybackEvent"
Returns AnimationPlaybackEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7590
createEvent(eventInterface: "AudioProcessingEvent"): AudioProcessingEvent
Parameters
- eventInterface: "AudioProcessingEvent"
Returns AudioProcessingEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7591
createEvent(eventInterface: "BeforeUnloadEvent"): BeforeUnloadEvent
Parameters
- eventInterface: "BeforeUnloadEvent"
Returns BeforeUnloadEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7592
createEvent(eventInterface: "BlobEvent"): BlobEvent
Parameters
- eventInterface: "BlobEvent"
Returns BlobEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7593
createEvent(eventInterface: "ClipboardEvent"): ClipboardEvent
Parameters
- eventInterface: "ClipboardEvent"
Returns ClipboardEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7594
createEvent(eventInterface: "CloseEvent"): CloseEvent
Parameters
- eventInterface: "CloseEvent"
Returns CloseEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7595
createEvent(eventInterface: "CompositionEvent"): CompositionEvent
Parameters
- eventInterface: "CompositionEvent"
Returns CompositionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7596
createEvent(
eventInterface: "ContentVisibilityAutoStateChangeEvent",
): ContentVisibilityAutoStateChangeEvent
Parameters
- eventInterface: "ContentVisibilityAutoStateChangeEvent"
Returns ContentVisibilityAutoStateChangeEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7597
createEvent(eventInterface: "CustomEvent"): CustomEvent<any>
Parameters
- eventInterface: "CustomEvent"
Returns CustomEvent<any>
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7598
createEvent(eventInterface: "DeviceMotionEvent"): DeviceMotionEvent
Parameters
- eventInterface: "DeviceMotionEvent"
Returns DeviceMotionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7599
createEvent(eventInterface: "DeviceOrientationEvent"): DeviceOrientationEvent
Parameters
- eventInterface: "DeviceOrientationEvent"
Returns DeviceOrientationEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7600
createEvent(eventInterface: "DragEvent"): DragEvent
Parameters
- eventInterface: "DragEvent"
Returns DragEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7601
createEvent(eventInterface: "ErrorEvent"): ErrorEvent
Parameters
- eventInterface: "ErrorEvent"
Returns ErrorEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7602
createEvent(eventInterface: "Event"): Event
Parameters
- eventInterface: "Event"
Returns Event
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7603
createEvent(eventInterface: "Events"): Event
Parameters
- eventInterface: "Events"
Returns Event
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7604
createEvent(eventInterface: "FocusEvent"): FocusEvent
Parameters
- eventInterface: "FocusEvent"
Returns FocusEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7605
createEvent(eventInterface: "FontFaceSetLoadEvent"): FontFaceSetLoadEvent
Parameters
- eventInterface: "FontFaceSetLoadEvent"
Returns FontFaceSetLoadEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7606
createEvent(eventInterface: "FormDataEvent"): FormDataEvent
Parameters
- eventInterface: "FormDataEvent"
Returns FormDataEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7607
createEvent(eventInterface: "GamepadEvent"): GamepadEvent
Parameters
- eventInterface: "GamepadEvent"
Returns GamepadEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7608
createEvent(eventInterface: "HashChangeEvent"): HashChangeEvent
Parameters
- eventInterface: "HashChangeEvent"
Returns HashChangeEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7609
createEvent(eventInterface: "IDBVersionChangeEvent"): IDBVersionChangeEvent
Parameters
- eventInterface: "IDBVersionChangeEvent"
Returns IDBVersionChangeEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7610
createEvent(eventInterface: "InputEvent"): InputEvent
Parameters
- eventInterface: "InputEvent"
Returns InputEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7611
createEvent(eventInterface: "KeyboardEvent"): KeyboardEvent
Parameters
- eventInterface: "KeyboardEvent"
Returns KeyboardEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7612
createEvent(eventInterface: "MIDIConnectionEvent"): MIDIConnectionEvent
Parameters
- eventInterface: "MIDIConnectionEvent"
Returns MIDIConnectionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7613
createEvent(eventInterface: "MIDIMessageEvent"): MIDIMessageEvent
Parameters
- eventInterface: "MIDIMessageEvent"
Returns MIDIMessageEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7614
createEvent(eventInterface: "MediaEncryptedEvent"): MediaEncryptedEvent
Parameters
- eventInterface: "MediaEncryptedEvent"
Returns MediaEncryptedEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7615
createEvent(eventInterface: "MediaKeyMessageEvent"): MediaKeyMessageEvent
Parameters
- eventInterface: "MediaKeyMessageEvent"
Returns MediaKeyMessageEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7616
createEvent(eventInterface: "MediaQueryListEvent"): MediaQueryListEvent
Parameters
- eventInterface: "MediaQueryListEvent"
Returns MediaQueryListEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7617
createEvent(eventInterface: "MediaStreamTrackEvent"): MediaStreamTrackEvent
Parameters
- eventInterface: "MediaStreamTrackEvent"
Returns MediaStreamTrackEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7618
createEvent(eventInterface: "MessageEvent"): MessageEvent<any>
Parameters
- eventInterface: "MessageEvent"
Returns MessageEvent<any>
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7619
createEvent(eventInterface: "MouseEvent"): MouseEvent
Parameters
- eventInterface: "MouseEvent"
Returns MouseEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7620
createEvent(eventInterface: "MouseEvents"): MouseEvent
Parameters
- eventInterface: "MouseEvents"
Returns MouseEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7621
createEvent(
eventInterface: "OfflineAudioCompletionEvent",
): OfflineAudioCompletionEvent
Parameters
- eventInterface: "OfflineAudioCompletionEvent"
Returns OfflineAudioCompletionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7622
createEvent(eventInterface: "PageTransitionEvent"): PageTransitionEvent
Parameters
- eventInterface: "PageTransitionEvent"
Returns PageTransitionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7623
createEvent(
eventInterface: "PaymentMethodChangeEvent",
): PaymentMethodChangeEvent
Parameters
- eventInterface: "PaymentMethodChangeEvent"
Returns PaymentMethodChangeEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7624
createEvent(
eventInterface: "PaymentRequestUpdateEvent",
): PaymentRequestUpdateEvent
Parameters
- eventInterface: "PaymentRequestUpdateEvent"
Returns PaymentRequestUpdateEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7625
createEvent(eventInterface: "PictureInPictureEvent"): PictureInPictureEvent
Parameters
- eventInterface: "PictureInPictureEvent"
Returns PictureInPictureEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7626
createEvent(eventInterface: "PointerEvent"): PointerEvent
Parameters
- eventInterface: "PointerEvent"
Returns PointerEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7627
createEvent(eventInterface: "PopStateEvent"): PopStateEvent
Parameters
- eventInterface: "PopStateEvent"
Returns PopStateEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7628
createEvent(eventInterface: "ProgressEvent"): ProgressEvent<EventTarget>
Parameters
- eventInterface: "ProgressEvent"
Returns ProgressEvent<EventTarget>
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7629
createEvent(eventInterface: "PromiseRejectionEvent"): PromiseRejectionEvent
Parameters
- eventInterface: "PromiseRejectionEvent"
Returns PromiseRejectionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7630
createEvent(eventInterface: "RTCDTMFToneChangeEvent"): RTCDTMFToneChangeEvent
Parameters
- eventInterface: "RTCDTMFToneChangeEvent"
Returns RTCDTMFToneChangeEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7631
createEvent(eventInterface: "RTCDataChannelEvent"): RTCDataChannelEvent
Parameters
- eventInterface: "RTCDataChannelEvent"
Returns RTCDataChannelEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7632
createEvent(eventInterface: "RTCErrorEvent"): RTCErrorEvent
Parameters
- eventInterface: "RTCErrorEvent"
Returns RTCErrorEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7633
createEvent(
eventInterface: "RTCPeerConnectionIceErrorEvent",
): RTCPeerConnectionIceErrorEvent
Parameters
- eventInterface: "RTCPeerConnectionIceErrorEvent"
Returns RTCPeerConnectionIceErrorEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7634
createEvent(
eventInterface: "RTCPeerConnectionIceEvent",
): RTCPeerConnectionIceEvent
Parameters
- eventInterface: "RTCPeerConnectionIceEvent"
Returns RTCPeerConnectionIceEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7635
createEvent(eventInterface: "RTCTrackEvent"): RTCTrackEvent
Parameters
- eventInterface: "RTCTrackEvent"
Returns RTCTrackEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7636
createEvent(
eventInterface: "SecurityPolicyViolationEvent",
): SecurityPolicyViolationEvent
Parameters
- eventInterface: "SecurityPolicyViolationEvent"
Returns SecurityPolicyViolationEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7637
createEvent(
eventInterface: "SpeechSynthesisErrorEvent",
): SpeechSynthesisErrorEvent
Parameters
- eventInterface: "SpeechSynthesisErrorEvent"
Returns SpeechSynthesisErrorEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7638
createEvent(eventInterface: "SpeechSynthesisEvent"): SpeechSynthesisEvent
Parameters
- eventInterface: "SpeechSynthesisEvent"
Returns SpeechSynthesisEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7639
createEvent(eventInterface: "StorageEvent"): StorageEvent
Parameters
- eventInterface: "StorageEvent"
Returns StorageEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7640
createEvent(eventInterface: "SubmitEvent"): SubmitEvent
Parameters
- eventInterface: "SubmitEvent"
Returns SubmitEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7641
createEvent(eventInterface: "TextEvent"): TextEvent
Parameters
- eventInterface: "TextEvent"
Returns TextEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7642
createEvent(eventInterface: "ToggleEvent"): ToggleEvent
Parameters
- eventInterface: "ToggleEvent"
Returns ToggleEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7643
createEvent(eventInterface: "TouchEvent"): TouchEvent
Parameters
- eventInterface: "TouchEvent"
Returns TouchEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7644
createEvent(eventInterface: "TrackEvent"): TrackEvent
Parameters
- eventInterface: "TrackEvent"
Returns TrackEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7645
createEvent(eventInterface: "TransitionEvent"): TransitionEvent
Parameters
- eventInterface: "TransitionEvent"
Returns TransitionEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7646
createEvent(eventInterface: "UIEvent"): UIEvent
Parameters
- eventInterface: "UIEvent"
Returns UIEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7647
createEvent(eventInterface: "UIEvents"): UIEvent
Parameters
- eventInterface: "UIEvents"
Returns UIEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7648
createEvent(eventInterface: "WebGLContextEvent"): WebGLContextEvent
Parameters
- eventInterface: "WebGLContextEvent"
Returns WebGLContextEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7649
createEvent(eventInterface: "WheelEvent"): WheelEvent
Parameters
- eventInterface: "WheelEvent"
Returns WheelEvent
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7650
createEvent(eventInterface: string): Event
Parameters
- eventInterface: string
Returns Event
Inherited from Document.createEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7651

createExpression

createExpression(
expression: string,
resolver?: null | XPathNSResolver,
): XPathExpression
MDN Reference
Parameters
- expression: string
- Optionalresolver: null | XPathNSResolver
Returns XPathExpression
Inherited from Document.createExpression
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:27047

createNodeIterator

createNodeIterator(
    root: Node,
    whatToShow?: number,
    filter?: null | NodeFilter,
): NodeIterator
Creates a NodeIterator object that you can use to traverse filtered lists of nodes or elements in a document.
Parameters
- root: Node
  The root element or node to start traversing on.
- OptionalwhatToShow: number
  The type of nodes or elements to appear in the node list
- Optionalfilter: null | NodeFilter
  A custom NodeFilter function to use. For more information, see filter. Use null for no filter.
  
  MDN Reference
Returns NodeIterator
Inherited from Document.createNodeIterator
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7660

createNSResolver

createNSResolver(nodeResolver: Node): Node
Parameters
- nodeResolver: Node
Returns Node
Deprecated
MDN Reference
Inherited from Document.createNSResolver
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:27053

createProcessingInstruction

createProcessingInstruction(target: string, data: string): ProcessingInstruction
Returns a ProcessingInstruction node whose target is target and data is data. If target does not match the Name production an "InvalidCharacterError" DOMException will be thrown. If data contains "?>" an "InvalidCharacterError" DOMException will be thrown.

MDN Reference
Parameters
- target: string
- data: string
Returns ProcessingInstruction
Inherited from Document.createProcessingInstruction
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7666

createRange

createRange(): Range
Returns an empty range object that has both of its boundary points positioned at the beginning of the document.

MDN Reference

Returns Range
Inherited from Document.createRange
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7672

createTextNode

createTextNode(data: string): Text
Creates a text string from the specified value.
Parameters
- data: string
  String that specifies the nodeValue property of the text node.
  
  MDN Reference
Returns Text
Inherited from Document.createTextNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7679

createTreeWalker

createTreeWalker(
    root: Node,
    whatToShow?: number,
    filter?: null | NodeFilter,
): TreeWalker
Creates a TreeWalker object that you can use to traverse filtered lists of nodes or elements in a document.
Parameters
- root: Node
  The root element or node to start traversing on.
- OptionalwhatToShow: number
  The type of nodes or elements to appear in the node list. For more information, see whatToShow.
- Optionalfilter: null | NodeFilter
  A custom NodeFilter function to use.
  
  MDN Reference
Returns TreeWalker
Inherited from Document.createTreeWalker
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7688

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.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from Document.dispatchEvent
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:8719

elementFromPoint

elementFromPoint(x: number, y: number): null | Element
Returns the element for the specified x coordinate and the specified y coordinate.
Parameters
- x: number
  The x-offset
- y: number
  The y-offset
Returns null | Element
Inherited from Document.elementFromPoint
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7905

elementsFromPoint

elementsFromPoint(x: number, y: number): Element[]
Parameters
- x: number
- y: number
Returns Element[]
Inherited from Document.elementsFromPoint
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7906

evaluate

evaluate(
    expression: string,
    contextNode: Node,
    resolver?: null | XPathNSResolver,
    type?: number,
    result?: null | XPathResult,
): XPathResult
MDN Reference
Parameters
- expression: string
- contextNode: Node
- Optionalresolver: null | XPathNSResolver
- Optionaltype: number
- Optionalresult: null | XPathResult
Returns XPathResult
Inherited from Document.evaluate
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:27055

execCommand

execCommand(commandId: string, showUI?: boolean, value?: string): boolean
Executes a command on the current document, current selection, or the given range.
Parameters
- commandId: string
  String that specifies the command to execute. This command can be any of the command identifiers that can be executed in script.
- OptionalshowUI: boolean
  Display the user interface, defaults to false.
- Optionalvalue: string
  Value to assign.
Returns boolean
Deprecated
MDN Reference
Inherited from Document.execCommand
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7698

exitFullscreen

exitFullscreen(): Promise<void>
Stops document's fullscreen element from being displayed fullscreen and resolves promise when done.

MDN Reference

Returns Promise<void>
Inherited from Document.exitFullscreen
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7704

exitPictureInPicture

exitPictureInPicture(): Promise<void>
MDN Reference

Returns Promise<void>
Inherited from Document.exitPictureInPicture
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7706

exitPointerLock

exitPointerLock(): void
MDN Reference

Returns void
Inherited from Document.exitPointerLock
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7708

getAnimations

getAnimations(): Animation[]
MDN Reference

Returns Animation[]
Inherited from Document.getAnimations
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7908

getElementById

getElementById(elementId: string): null | HTMLElement
Returns a reference to the first object with the specified value of the ID attribute.
Parameters
- elementId: string
  String that specifies the ID value.
Returns null | HTMLElement
Inherited from Document.getElementById
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7713

getElementsByClassName

getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

MDN Reference
Parameters
- classNames: string
Returns HTMLCollectionOf<Element>
Inherited from Document.getElementsByClassName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7719

getElementsByName

getElementsByName(elementName: string): NodeListOf<HTMLElement>
Gets a collection of objects based on the value of the NAME or ID attribute.
Parameters
- elementName: string
  Gets a collection of objects based on the value of the NAME or ID attribute.
  
  MDN Reference
Returns NodeListOf<HTMLElement>
Inherited from Document.getElementsByName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7726

getElementsByTagName

getElementsByTagName<K extends keyof HTMLElementTagNameMap>(
qualifiedName: K,
): HTMLCollectionOf<HTMLElementTagNameMap[K]>
Retrieves a collection of objects based on the specified element name.
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from Document.getElementsByTagName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7733
getElementsByTagName<K extends keyof SVGElementTagNameMap>(
qualifiedName: K,
): HTMLCollectionOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from Document.getElementsByTagName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7734
getElementsByTagName<K extends keyof MathMLElementTagNameMap>(
qualifiedName: K,
): HTMLCollectionOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from Document.getElementsByTagName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7735
getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(
qualifiedName: K,
): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from Document.getElementsByTagName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7737
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
Parameters
- qualifiedName: string
Returns HTMLCollectionOf<Element>
Inherited from Document.getElementsByTagName
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7738

getElementsByTagNameNS

getElementsByTagNameNS(
namespaceURI: "http://www.w3.org/1999/xhtml",
localName: string,
): HTMLCollectionOf<HTMLElement>
If namespace and localName are "*" returns a HTMLCollection of all descendant elements.

If only namespace is "*" returns a HTMLCollection of all descendant elements whose local name is localName.

If only localName is "*" returns a HTMLCollection of all descendant elements whose namespace is namespace.

Otherwise, returns a HTMLCollection of all descendant elements whose namespace is namespace and local name is localName.

MDN Reference
Parameters
- namespaceURI: "http://www.w3.org/1999/xhtml"
- localName: string
Returns HTMLCollectionOf<HTMLElement>
Inherited from Document.getElementsByTagNameNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7750
getElementsByTagNameNS(
namespaceURI: "http://www.w3.org/2000/svg",
localName: string,
): HTMLCollectionOf<SVGElement>
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- localName: string
Returns HTMLCollectionOf<SVGElement>
Inherited from Document.getElementsByTagNameNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7751
getElementsByTagNameNS(
namespaceURI: "http://www.w3.org/1998/Math/MathML",
localName: string,
): HTMLCollectionOf<MathMLElement>
Parameters
- namespaceURI: "http://www.w3.org/1998/Math/MathML"
- localName: string
Returns HTMLCollectionOf<MathMLElement>
Inherited from Document.getElementsByTagNameNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7752
getElementsByTagNameNS(
namespace: null | string,
localName: string,
): HTMLCollectionOf<Element>
Parameters
- namespace: null | string
- localName: string
Returns HTMLCollectionOf<Element>
Inherited from Document.getElementsByTagNameNS
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7753

getRootNode

getRootNode(options?: GetRootNodeOptions): Node
Returns node's root.

MDN Reference
Parameters
- Optionaloptions: GetRootNodeOptions
Returns Node
Inherited from Document.getRootNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16683

getSelection

getSelection(): null | Selection
Returns an object representing the current selection of the document that is loaded into the object displaying a webpage.

MDN Reference

Returns null | Selection
Inherited from Document.getSelection
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7759

hasChildNodes

hasChildNodes(): boolean
Returns whether node has children.

MDN Reference

Returns boolean
Inherited from Document.hasChildNodes
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16689

hasFocus

hasFocus(): boolean
Gets a value indicating whether the object currently has focus.

MDN Reference

Returns boolean
Inherited from Document.hasFocus
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7765

hasStorageAccess

hasStorageAccess(): Promise<boolean>
MDN Reference

Returns Promise<boolean>
Inherited from Document.hasStorageAccess
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7767

importNode

importNode<T extends Node>(node: T, deep?: boolean): T
Returns a copy of node. If deep is true, the copy also includes the node's descendants.

If node is a document or a shadow root, throws a "NotSupportedError" DOMException.

MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
- Optionaldeep: boolean
Returns T
Inherited from Document.importNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7775

insertBefore

insertBefore<T extends Node>(node: T, child: null | Node): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
- child: null | Node
Returns T
Inherited from Document.insertBefore
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16691

isDefaultNamespace

isDefaultNamespace(namespace: null | string): boolean
MDN Reference
Parameters
- namespace: null | string
Returns boolean
Inherited from Document.isDefaultNamespace
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16693

isEqualNode

isEqualNode(otherNode: null | Node): boolean
Returns whether node and otherNode have the same properties.

MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from Document.isEqualNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16699

isSameNode

isSameNode(otherNode: null | Node): boolean
MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from Document.isSameNode
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16701

lookupNamespaceURI

lookupNamespaceURI(prefix: null | string): null | string
MDN Reference
Parameters
- prefix: null | string
Returns null | string
Inherited from Document.lookupNamespaceURI
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16703

lookupPrefix

lookupPrefix(namespace: null | string): null | string
MDN Reference
Parameters
- namespace: null | string
Returns null | string
Inherited from Document.lookupPrefix
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16705

normalize

normalize(): void
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

MDN Reference

Returns void
Inherited from Document.normalize
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16711

open

open(unused1?: string, unused2?: string): Document
Opens a new window and loads a document specified by a given URL. Also, opens a new window that uses the url parameter and the name parameter to collect the output of the write method and the writeln method.
Parameters
- Optionalunused1: string
- Optionalunused2: string
Returns Document
Inherited from Document.open
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7785
open(url: string | URL, name: string, features: string): null | Window
Parameters
- url: string | URL
- name: string
- features: string
Returns null | Window
Inherited from Document.open
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7786

prepend

prepend(...nodes: (string | Node)[]): void
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- ...nodes: (string | Node)[]
Returns void
Inherited from Document.prepend
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17315

queryCommandEnabled

queryCommandEnabled(commandId: string): boolean
Returns a Boolean value that indicates whether a specified command can be successfully executed using execCommand, given the current state of the document.
Parameters
- commandId: string
  Specifies a command identifier.
Returns boolean
Deprecated
MDN Reference
Inherited from Document.queryCommandEnabled
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7794

queryCommandIndeterm

queryCommandIndeterm(commandId: string): boolean
Returns a Boolean value that indicates whether the specified command is in the indeterminate state.
Parameters
- commandId: string
  String that specifies a command identifier.
Returns boolean
Deprecated
Inherited from Document.queryCommandIndeterm
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7800

queryCommandState

queryCommandState(commandId: string): boolean
Returns a Boolean value that indicates the current state of the command.
Parameters
- commandId: string
  String that specifies a command identifier.
Returns boolean
Deprecated
MDN Reference
Inherited from Document.queryCommandState
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7808

queryCommandSupported

queryCommandSupported(commandId: string): boolean
Returns a Boolean value that indicates whether the current command is supported on the current range.
Parameters
- commandId: string
  Specifies a command identifier.
Returns boolean
Deprecated
MDN Reference
Inherited from Document.queryCommandSupported
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7816

queryCommandValue

queryCommandValue(commandId: string): string
Returns the current value of the document, range, or current selection for the given command.
Parameters
- commandId: string
  String that specifies a command identifier.
Returns string
Deprecated
Inherited from Document.queryCommandValue
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7822

querySelector

querySelector<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): null | HTMLElementTagNameMap[K]
Returns the first element that is a descendant of node that matches selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementTagNameMap[K]
Inherited from Document.querySelector
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17321
querySelector<K extends keyof SVGElementTagNameMap>(
selectors: K,
): null | SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns null | SVGElementTagNameMap[K]
Inherited from Document.querySelector
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17322
querySelector<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): null | MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns null | MathMLElementTagNameMap[K]
Inherited from Document.querySelector
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17323
querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): null | HTMLElementDeprecatedTagNameMap[K]
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementDeprecatedTagNameMap[K]
Deprecated
Inherited from Document.querySelector
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17325
querySelector<E extends Element = Element>(selectors: string): null | E
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns null | E
Inherited from Document.querySelector
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17326

querySelectorAll

querySelectorAll<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): NodeListOf<HTMLElementTagNameMap[K]>
Returns all element descendants of node that match selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
Inherited from Document.querySelectorAll
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17332
querySelectorAll<K extends keyof SVGElementTagNameMap>(
selectors: K,
): NodeListOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
Inherited from Document.querySelectorAll
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17333
querySelectorAll<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): NodeListOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<MathMLElementTagNameMap[K]>
Inherited from Document.querySelectorAll
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17334
querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from Document.querySelectorAll
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17336
querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns NodeListOf<E>
Inherited from Document.querySelectorAll
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17337

releaseEvents

releaseEvents(): void
Returns void
Deprecated
Inherited from Document.releaseEvents
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7824

removeChild

removeChild<T extends Node>(child: T): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- child: T
Returns T
Inherited from Document.removeChild
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16713

removeEventListener

removeEventListener<K extends keyof DocumentEventMap>(
    type: K,
    listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- K extends keyof DocumentEventMap
Parameters
- type: K
- listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides Document.removeEventListener
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:26813
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides Document.removeEventListener
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:26814

replaceChild

replaceChild<T extends Node>(node: Node, child: T): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: Node
- child: T
Returns T
Inherited from Document.replaceChild
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:16715

replaceChildren

replaceChildren(...nodes: (string | Node)[]): void
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- ...nodes: (string | Node)[]
Returns void
Inherited from Document.replaceChildren
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:17345

requestStorageAccess

requestStorageAccess(): Promise<void>
MDN Reference

Returns Promise<void>
Inherited from Document.requestStorageAccess
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7826

startViewTransition

startViewTransition(
callbackOptions?: ViewTransitionUpdateCallback,
): ViewTransition
MDN Reference
Parameters
- OptionalcallbackOptions: ViewTransitionUpdateCallback
Returns ViewTransition
Inherited from Document.startViewTransition
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7828

write

write(...text: string[]): void
Writes one or more HTML expressions to a document in the specified window.
Parameters
- ...text: string[]
Returns void
Inherited from Document.write
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7835

writeln

writeln(...text: string[]): void
Writes one or more HTML expressions, followed by a carriage return, to a document in the specified window.
Parameters
- ...text: string[]
Returns void
Inherited from Document.writeln
- Defined in ../node_modules/typescript/lib/lib.dom.d.ts:7842

Interface XMLDocument

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

ReadonlyactiveElement

adoptedStyleSheets

alinkColor

Deprecated

Readonlyall

Deprecated

Readonlyanchors

Deprecated

Readonlyapplets

Deprecated

ReadonlyATTRIBUTE_NODE

ReadonlybaseURI

bgColor

Deprecated

body

ReadonlyCDATA_SECTION_NODE

ReadonlycharacterSet

Readonlycharset

Deprecated

ReadonlychildElementCount

ReadonlychildNodes

Readonlychildren

ReadonlyCOMMENT_NODE

ReadonlycompatMode

ReadonlycontentType

cookie

ReadonlycurrentScript

ReadonlydefaultView

designMode

dir

Readonlydoctype

ReadonlyDOCUMENT_FRAGMENT_NODE

ReadonlyDOCUMENT_NODE

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

ReadonlyDOCUMENT_POSITION_CONTAINS

ReadonlyDOCUMENT_POSITION_DISCONNECTED

ReadonlyDOCUMENT_POSITION_FOLLOWING

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

ReadonlyDOCUMENT_POSITION_PRECEDING

ReadonlyDOCUMENT_TYPE_NODE

ReadonlydocumentElement

ReadonlydocumentURI

domain

Deprecated

ReadonlyELEMENT_NODE

Readonlyembeds

ReadonlyENTITY_NODE

ReadonlyENTITY_REFERENCE_NODE

fgColor

Deprecated

ReadonlyfirstChild

ReadonlyfirstElementChild

Readonlyfonts

Readonlyforms

ReadonlyfragmentDirective

Readonlyfullscreen

Deprecated

ReadonlyfullscreenElement

ReadonlyfullscreenEnabled

Readonlyhead

Readonlyhidden

Readonlyimages

Readonlyimplementation

ReadonlyinputEncoding

Deprecated

ReadonlyisConnected

ReadonlylastChild

ReadonlylastElementChild

ReadonlylastModified

linkColor

Deprecated

Readonlylinks

ReadonlynextSibling

`Readonly`activeElement

`Readonly`all

`Readonly`anchors

`Readonly`applets

`Readonly`ATTRIBUTE_NODE

`Readonly`baseURI

`Readonly`CDATA_SECTION_NODE

`Readonly`characterSet

`Readonly`charset

`Readonly`childElementCount

`Readonly`childNodes

`Readonly`children

`Readonly`COMMENT_NODE

`Readonly`compatMode

`Readonly`contentType

`Readonly`currentScript

`Readonly`defaultView

`Readonly`doctype

`Readonly`DOCUMENT_FRAGMENT_NODE

`Readonly`DOCUMENT_NODE

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

`Readonly`DOCUMENT_POSITION_CONTAINS

`Readonly`DOCUMENT_POSITION_DISCONNECTED

`Readonly`DOCUMENT_POSITION_FOLLOWING

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly`DOCUMENT_POSITION_PRECEDING

`Readonly`DOCUMENT_TYPE_NODE

`Readonly`documentElement

`Readonly`documentURI

`Readonly`ELEMENT_NODE

`Readonly`embeds

`Readonly`ENTITY_NODE

`Readonly`ENTITY_REFERENCE_NODE

`Readonly`firstChild

`Readonly`firstElementChild

`Readonly`fonts

`Readonly`forms

`Readonly`fragmentDirective

`Readonly`fullscreen

`Readonly`fullscreenElement

`Readonly`fullscreenEnabled

`Readonly`head

`Readonly`hidden

`Readonly`images

`Readonly`implementation

`Readonly`inputEncoding

`Readonly`isConnected

`Readonly`lastChild

`Readonly`lastElementChild

`Readonly`lastModified

`Readonly`links

`Readonly`nextSibling

`Readonly`nodeName

`Readonly`nodeType

`Readonly`NOTATION_NODE