Document

Values

addEventListener

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. Read more on MDN

let addEventListener: (
  DomTypes.document,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

DomTypes.document EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

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. Read more on MDN

let addEventListenerWithCapture: (
  DomTypes.document,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

DomTypes.document EventTypes.eventType EventTypes.eventListener

Return type

unit

adoptNode

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. Read more on MDN

let adoptNode: (DomTypes.document, 't) => 't

append

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. Read more on MDN

let append: (DomTypes.document, DomTypes.node) => unit

Parameters

DomTypes.document DomTypes.node

Return type

unit

append2

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. Read more on MDN

let append2: (DomTypes.document, string) => unit

Parameters

DomTypes.document string

Return type

unit

appendChild

Read more on MDN

let appendChild: (DomTypes.document, 't) => 't

asEventTarget

let asEventTarget: DomTypes.document => EventTypes.eventTarget

Parameters

DomTypes.document

Return type

EventTypes.eventTarget

asNode

let asNode: DomTypes.document => DomTypes.node

Parameters

DomTypes.document

Return type

DomTypes.node

caretPositionFromPoint

Read more on MDN

let caretPositionFromPoint: (
  DomTypes.document,
  ~x: float,
  ~y: float,
  ~options: DomTypes.caretPositionFromPointOptions=?,
) => DomTypes.caretPosition

Parameters

DomTypes.document float float option< DomTypes.caretPositionFromPointOptions >

Return type

DomTypes.caretPosition

cloneNode

Returns a copy of node. If deep is true, the copy also includes the node's descendants. Read more on MDN

let cloneNode: (DomTypes.document, ~deep: bool=?) => DomTypes.document

Parameters

DomTypes.document option< bool >

Return type

DomTypes.document

close

Closes an output stream and forces the sent data to display. Read more on MDN

let close: DomTypes.document => unit

Parameters

DomTypes.document

Return type

unit

compareDocumentPosition

Returns a bitmask indicating the position of other relative to node. Read more on MDN

let compareDocumentPosition: (DomTypes.document, DomTypes.node) => int

Parameters

DomTypes.document DomTypes.node

Return type

int

contains

Returns true if other is an inclusive descendant of node, and false otherwise. Read more on MDN

let contains: (DomTypes.document, DomTypes.node) => bool

Parameters

DomTypes.document DomTypes.node

Return type

bool

createAttribute

Creates an attribute object with a specified name. @param name String that sets the attribute object's name. Read more on MDN

let createAttribute: (DomTypes.document, string) => DomTypes.attr

Parameters

DomTypes.document string

Return type

DomTypes.attr

createAttributeNS

Read more on MDN

let createAttributeNS: (
  DomTypes.document,
  ~namespace: string,
  ~qualifiedName: string,
) => DomTypes.attr

Parameters

DomTypes.document string string

Return type

DomTypes.attr

createCDATASection

Returns a CDATASection node whose data is data. Read more on MDN

let createCDATASection: (DomTypes.document, string) => DomTypes.cdataSection

Parameters

DomTypes.document string

Return type

DomTypes.cdataSection

createComment

Creates a comment object with the specified data. @param data Sets the comment object's data. Read more on MDN

let createComment: (DomTypes.document, string) => DomTypes.comment

Parameters

DomTypes.document string

Return type

DomTypes.comment

createDocumentFragment

Creates a new document. Read more on MDN

let createDocumentFragment: DomTypes.document => DomTypes.documentFragment

Parameters

DomTypes.document

Return type

DomTypes.documentFragment

createElement

Creates an instance of the element for the specified tag. @param tagName The name of an element. Read more on MDN

let createElement: (
  DomTypes.document,
  string,
  ~options: string=?,
) => DomTypes.element

Parameters

DomTypes.document string option< string >

Return type

DomTypes.element

createElement2

Creates an instance of the element for the specified tag. @param tagName The name of an element. Read more on MDN

let createElement2: (
  DomTypes.document,
  ~localName: string,
  ~options: DomTypes.elementCreationOptions=?,
) => DomTypes.element

Parameters

DomTypes.document string option< DomTypes.elementCreationOptions >

Return type

DomTypes.element

createElementNS

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. Read more on MDN

let createElementNS: (
  DomTypes.document,
  ~namespace: string,
  ~qualifiedName: string,
  ~options: string=?,
) => DomTypes.element

Parameters

DomTypes.document string string option< string >

Return type

DomTypes.element

createElementNS2

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. Read more on MDN

let createElementNS2: (
  DomTypes.document,
  ~namespace: string,
  ~qualifiedName: string,
  ~options: DomTypes.elementCreationOptions=?,
) => DomTypes.element

Parameters

DomTypes.document string string option< DomTypes.elementCreationOptions >

Return type

DomTypes.element

createEvent

Read more on MDN

let createEvent: (DomTypes.document, string) => EventTypes.event

Parameters

DomTypes.document string

Return type

EventTypes.event

createExpression

Read more on MDN

let createExpression: (
  DomTypes.document,
  ~expression: string,
  ~resolver: DomTypes.xPathNSResolver=?,
) => DomTypes.xPathExpression

Parameters

DomTypes.document string option< DomTypes.xPathNSResolver >

Return type

DomTypes.xPathExpression

createNodeIterator

Creates a NodeIterator object that you can use to traverse filtered lists of nodes or elements in a document. @param root The root element or node to start traversing on. @param whatToShow The type of nodes or elements to appear in the node list @param filter A custom NodeFilter function to use. For more information, see filter. Use null for no filter. Read more on MDN

let createNodeIterator: (
  DomTypes.document,
  ~root: DomTypes.node,
  ~whatToShow: int=?,
  ~filter: DomTypes.nodeFilter=?,
) => DomTypes.nodeIterator

Parameters

DomTypes.document DomTypes.node option< int > option< DomTypes.nodeFilter >

Return type

DomTypes.nodeIterator

createProcessingInstruction

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. Read more on MDN

let createProcessingInstruction: (
  DomTypes.document,
  ~target: string,
  ~data: string,
) => DomTypes.processingInstruction

Parameters

DomTypes.document string string

Return type

DomTypes.processingInstruction

createRange

Returns an empty range object that has both of its boundary points positioned at the beginning of the document. Read more on MDN

let createRange: DomTypes.document => DomTypes.range

Parameters

DomTypes.document

Return type

DomTypes.range

createTextNode

Creates a text string from the specified value. @param data String that specifies the nodeValue property of the text node. Read more on MDN

let createTextNode: (DomTypes.document, string) => DomTypes.text

Parameters

DomTypes.document string

Return type

DomTypes.text

createTreeWalker

Creates a TreeWalker object that you can use to traverse filtered lists of nodes or elements in a document. @param root The root element or node to start traversing on. @param whatToShow The type of nodes or elements to appear in the node list. For more information, see whatToShow. @param filter A custom NodeFilter function to use. Read more on MDN

let createTreeWalker: (
  DomTypes.document,
  ~root: DomTypes.node,
  ~whatToShow: int=?,
  ~filter: DomTypes.nodeFilter=?,
) => DomTypes.treeWalker

Parameters

DomTypes.document DomTypes.node option< int > option< DomTypes.nodeFilter >

Return type

DomTypes.treeWalker

dispatchEvent

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. Read more on MDN

let dispatchEvent: (DomTypes.document, EventTypes.event) => bool

Parameters

DomTypes.document EventTypes.event

Return type

bool

evaluate

Read more on MDN

let evaluate: (
  DomTypes.document,
  ~expression: string,
  ~contextNode: DomTypes.node,
  ~resolver: DomTypes.xPathNSResolver=?,
  ~type_: int=?,
  ~result: DomTypes.xPathResult=?,
) => DomTypes.xPathResult

Parameters

DomTypes.document string DomTypes.node option< DomTypes.xPathNSResolver > option< int > option< DomTypes.xPathResult >

Return type

DomTypes.xPathResult

exitFullscreen

Stops document's fullscreen element from being displayed fullscreen and resolves promise when done. Read more on MDN

let exitFullscreen: DomTypes.document => promise<unit>

Parameters

DomTypes.document

Return type

promise< unit >

exitPictureInPicture

Read more on MDN

let exitPictureInPicture: DomTypes.document => promise<unit>

Parameters

DomTypes.document

Return type

promise< unit >

exitPointerLock

Read more on MDN

let exitPointerLock: DomTypes.document => unit

Parameters

DomTypes.document

Return type

unit

getAnimations

Read more on MDN

let getAnimations: DomTypes.document => array<DomTypes.animation>

Parameters

DomTypes.document

Return type

array< DomTypes.animation >

getElementById

Returns the first element within node's descendants whose ID is elementId. Read more on MDN

let getElementById: (DomTypes.document, string) => null<DomTypes.element>

Parameters

DomTypes.document string

Return type

Stdlib.null< DomTypes.element >

getElementsByClassName

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. Read more on MDN

let getElementsByClassName: (
  DomTypes.document,
  string,
) => DomTypes.htmlCollection<DomTypes.element>

Parameters

DomTypes.document string

Return type

DomTypes.htmlCollection< DomTypes.element >

getElementsByName

Gets a collection of objects based on the value of the NAME or ID attribute. @param elementName Gets a collection of objects based on the value of the NAME or ID attribute. Read more on MDN

let getElementsByName: (
  DomTypes.document,
  string,
) => DomTypes.nodeList<DomTypes.htmlElement>

Parameters

DomTypes.document string

Return type

DomTypes.nodeList< DomTypes.htmlElement >

getElementsByTagName

Retrieves a collection of objects based on the specified element name. @param name Specifies the name of an element. Read more on MDN

let getElementsByTagName: (
  DomTypes.document,
  string,
) => DomTypes.htmlCollection<DomTypes.element>

Parameters

DomTypes.document string

Return type

DomTypes.htmlCollection< DomTypes.element >

getElementsByTagNameNS

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. Read more on MDN

let getElementsByTagNameNS: (
  DomTypes.document,
  ~namespace: string,
  ~localName: string,
) => DomTypes.htmlCollection<DomTypes.element>

Parameters

DomTypes.document string string

Return type

DomTypes.htmlCollection< DomTypes.element >

getRootNode

Returns node's root. Read more on MDN

let getRootNode: (
  DomTypes.document,
  ~options: DomTypes.getRootNodeOptions=?,
) => DomTypes.node

Parameters

DomTypes.document option< DomTypes.getRootNodeOptions >

Return type

DomTypes.node

getSelection

Returns an object representing the current selection of the document that is loaded into the object displaying a webpage. Read more on MDN

let getSelection: DomTypes.document => null<DomTypes.selection>

Parameters

DomTypes.document

Return type

Stdlib.null< DomTypes.selection >

hasChildNodes

Returns whether node has children. Read more on MDN

let hasChildNodes: DomTypes.document => bool

Parameters

DomTypes.document

Return type

bool

hasFocus

Gets a value indicating whether the object currently has focus. Read more on MDN

let hasFocus: DomTypes.document => bool

Parameters

DomTypes.document

Return type

bool

hasStorageAccess

Read more on MDN

let hasStorageAccess: DomTypes.document => promise<bool>

Parameters

DomTypes.document

Return type

promise< bool >

importNode

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. Read more on MDN

let importNode: (DomTypes.document, 't, ~deep: bool=?) => 't

Parameters

DomTypes.document

Return type

option< bool >

insertBefore

Read more on MDN

let insertBefore: (DomTypes.document, 't, ~child: DomTypes.node) => 't

Parameters

DomTypes.document

Return type

DomTypes.node

isDefaultNamespace

Read more on MDN

let isDefaultNamespace: (DomTypes.document, string) => bool

Parameters

DomTypes.document string

Return type

bool

isEqualNode

Returns whether node and otherNode have the same properties. Read more on MDN

let isEqualNode: (DomTypes.document, DomTypes.node) => bool

Parameters

DomTypes.document DomTypes.node

Return type

bool

isInstanceOf

let isInstanceOf: 't => bool

isSameNode

Read more on MDN

let isSameNode: (DomTypes.document, DomTypes.node) => bool

Parameters

DomTypes.document DomTypes.node

Return type

bool

lookupNamespaceURI

Read more on MDN

let lookupNamespaceURI: (DomTypes.document, string) => string

Parameters

DomTypes.document string

Return type

string

lookupPrefix

Read more on MDN

let lookupPrefix: (DomTypes.document, string) => string

Parameters

DomTypes.document string

Return type

string

make

Read more on MDN

let make: unit => DomTypes.document

Parameters

unit

Return type

DomTypes.document

normalize

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. Read more on MDN

let normalize: DomTypes.document => unit

Parameters

DomTypes.document

Return type

unit

open_

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. @param url Specifies a MIME type for the document. @param name Specifies the name of the window. This name is used as the value for the TARGET attribute on a form or an anchor element. @param features Contains a list of items separated by commas. Each item consists of an option and a value, separated by an equals sign (for example, "fullscreen=yes, toolbar=yes"). The following values are supported. @param replace Specifies whether the existing entry for the document is replaced in the history list. Read more on MDN

let open_: (
  DomTypes.document,
  ~unused1: string=?,
  ~unused2: string=?,
) => DomTypes.document

Parameters

DomTypes.document option< string > option< string >

Return type

DomTypes.document

open2

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. @param url Specifies a MIME type for the document. @param name Specifies the name of the window. This name is used as the value for the TARGET attribute on a form or an anchor element. @param features Contains a list of items separated by commas. Each item consists of an option and a value, separated by an equals sign (for example, "fullscreen=yes, toolbar=yes"). The following values are supported. @param replace Specifies whether the existing entry for the document is replaced in the history list. Read more on MDN

let open2: (
  DomTypes.document,
  ~url: string,
  ~name: string,
  ~features: string,
) => DomTypes.window

Parameters

DomTypes.document string string string

Return type

DomTypes.window

parseHTMLUnsafe

Read more on MDN

let parseHTMLUnsafe: string => DomTypes.document

Parameters

string

Return type

DomTypes.document

prepend

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. Read more on MDN

let prepend: (DomTypes.document, DomTypes.node) => unit

Parameters

DomTypes.document DomTypes.node

Return type

unit

prepend2

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. Read more on MDN

let prepend2: (DomTypes.document, string) => unit

Parameters

DomTypes.document string

Return type

unit

querySelector

Returns the first element that is a descendant of node that matches selectors. Read more on MDN

let querySelector: (DomTypes.document, string) => Null.t<DomTypes.element>

Parameters

DomTypes.document string

Return type

Stdlib.Null.t< DomTypes.element >

querySelectorAll

Returns all element descendants of node that match selectors. Read more on MDN

let querySelectorAll: (
  DomTypes.document,
  string,
) => DomTypes.nodeList<DomTypes.element>

Parameters

DomTypes.document string

Return type

DomTypes.nodeList< DomTypes.element >

removeChild

Read more on MDN

let removeChild: (DomTypes.document, 't) => 't

removeEventListener

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener: (
  DomTypes.document,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

DomTypes.document EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListenerUseCapture: (
  DomTypes.document,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

DomTypes.document EventTypes.eventType EventTypes.eventListener

Return type

unit

replaceChild

Read more on MDN

let replaceChild: (DomTypes.document, ~node: DomTypes.node, 't) => 't

Parameters

DomTypes.document

Return type

DomTypes.node

replaceChildren

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. Read more on MDN

let replaceChildren: (DomTypes.document, DomTypes.node) => unit

Parameters

DomTypes.document DomTypes.node

Return type

unit

replaceChildren2

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. Read more on MDN

let replaceChildren2: (DomTypes.document, string) => unit

Parameters

DomTypes.document string

Return type

unit

requestStorageAccess

Read more on MDN

let requestStorageAccess: DomTypes.document => promise<unit>

Parameters

DomTypes.document

Return type

promise< unit >

startViewTransition

Read more on MDN

let startViewTransition: (
  DomTypes.document,
  ~callbackOptions: ViewTransitionsTypes.viewTransitionUpdateCallback=?,
) => ViewTransitionsTypes.viewTransition

Parameters

DomTypes.document option< ViewTransitionsTypes.viewTransitionUpdateCallback >

Return type

ViewTransitionsTypes.viewTransition

write

Writes one or more HTML expressions to a document in the specified window. @param content Specifies the text and HTML tags to write. Read more on MDN

let write: (DomTypes.document, string) => unit

Parameters

DomTypes.document string

Return type

unit

writeln

Writes one or more HTML expressions, followed by a carriage return, to a document in the specified window. @param content The text and HTML tags to write. Read more on MDN

let writeln: (DomTypes.document, string) => unit

Parameters

DomTypes.document string

Return type

unit