Global
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: ( WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>, ~options: WebAPI.EventAPI.addEventListenerOptions=?,) => unit
Parameters
WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener option< WebAPI.EventAPI.addEventListenerOptions >Return type
unitaddEventListener_useCapture
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_useCapture: ( WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>,) => unit
cancelAnimationFrame
let cancelAnimationFrame: int => unit
Parameters
intReturn type
unitcancelIdleCallback
let cancelIdleCallback: int => unit
Parameters
intReturn type
unitclosed
Returns true if the window has been closed, false otherwise. Read more on MDN
let closed: bool
confirm
let confirm: (~message: string=?) => bool
Parameters
option< string >Return type
boolcreateImageBitmap
let createImageBitmap: ( ~image: WebAPI.DOMAPI.htmlImageElement, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.htmlImageElement option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap10
let createImageBitmap10: ( ~image: WebAPI.DOMAPI.htmlImageElement, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.htmlImageElement int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap11
let createImageBitmap11: ( ~image: WebAPI.DOMAPI.svgImageElement, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.svgImageElement int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap12
let createImageBitmap12: ( ~image: WebAPI.DOMAPI.htmlVideoElement, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.htmlVideoElement int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap13
let createImageBitmap13: ( ~image: WebAPI.DOMAPI.htmlCanvasElement, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.htmlCanvasElement int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap14
let createImageBitmap14: ( ~image: WebAPI.CanvasAPI.imageBitmap, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.CanvasAPI.imageBitmap int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap15
let createImageBitmap15: ( ~image: WebAPI.CanvasAPI.offscreenCanvas, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.CanvasAPI.offscreenCanvas int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap16
let createImageBitmap16: ( ~image: WebAPI.DOMAPI.videoFrame, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.videoFrame int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap17
let createImageBitmap17: ( ~image: WebAPI.FileAPI.blob, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.FileAPI.blob int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap18
let createImageBitmap18: ( ~image: WebAPI.DOMAPI.imageData, ~sx: int, ~sy: int, ~sw: int, ~sh: int, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.imageData int int int int option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap2
let createImageBitmap2: ( ~image: WebAPI.DOMAPI.svgImageElement, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.svgImageElement option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap3
let createImageBitmap3: ( ~image: WebAPI.DOMAPI.htmlVideoElement, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.htmlVideoElement option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap4
let createImageBitmap4: ( ~image: WebAPI.DOMAPI.htmlCanvasElement, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.htmlCanvasElement option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap5
let createImageBitmap5: ( ~image: WebAPI.CanvasAPI.imageBitmap, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.CanvasAPI.imageBitmap option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap6
let createImageBitmap6: ( ~image: WebAPI.CanvasAPI.offscreenCanvas, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.CanvasAPI.offscreenCanvas option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap7
let createImageBitmap7: ( ~image: WebAPI.DOMAPI.videoFrame, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.videoFrame option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap8
let createImageBitmap8: ( ~image: WebAPI.FileAPI.blob, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.FileAPI.blob option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >createImageBitmap9
let createImageBitmap9: ( ~image: WebAPI.DOMAPI.imageData, ~options: WebAPI.DOMAPI.imageBitmapOptions=?,) => promise<WebAPI.CanvasAPI.imageBitmap>
Parameters
WebAPI.DOMAPI.imageData option< WebAPI.DOMAPI.imageBitmapOptions >Return type
promise< WebAPI.CanvasAPI.imageBitmap >customElements
Defines a new custom element, mapping the given name to the given constructor as an autonomous custom element. Read more on MDN
let customElements: WebAPI.DOMAPI.customElementRegistry
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: WebAPI.EventAPI.event => bool
fetch
fetch(string, init)
Starts the process of fetching a resource from the network, returning a promise that is fulfilled once the response is available.
let response = await fetch("https://rescript-lang.org")
let fetch: ( string, ~init: WebAPI.FetchAPI.requestInit=?,) => promise<WebAPI.FetchAPI.response>
Parameters
string option< WebAPI.FetchAPI.requestInit >Return type
promise< WebAPI.FetchAPI.response >fetch_withRequest
fetch_withRequest(request, init)
Starts the process of fetching a resource from the network, returning a promise that is fulfilled once the response is available.
let response = await fetch(myRequest)
let fetch_withRequest: ( WebAPI.FetchAPI.request, ~init: WebAPI.FetchAPI.requestInit=?,) => promise<WebAPI.FetchAPI.response>
Parameters
WebAPI.FetchAPI.request option< WebAPI.FetchAPI.requestInit >Return type
promise< WebAPI.FetchAPI.response >focus
Moves the focus to the window's browsing context, if any. Read more on MDN
let focus: unit => unit
Parameters
unitReturn type
unitgetComputedStyle
let getComputedStyle: ( ~elt: WebAPI.DOMAPI.element, ~pseudoElt: string=?,) => WebAPI.DOMAPI.cssStyleDeclaration
getSelection
let getSelection: unit => WebAPI.DOMAPI.selection
locationbar
Returns true if the location bar is visible; otherwise, returns false. Read more on MDN
let locationbar: WebAPI.DOMAPI.barProp
matchMedia
let matchMedia: string => WebAPI.DOMAPI.mediaQueryList
menubar
Returns true if the menu bar is visible; otherwise, returns false. Read more on MDN
let menubar: WebAPI.DOMAPI.barProp
open_
let open_: ( ~url: string=?, ~target: string=?, ~features: string=?,) => WebAPI.DOMAPI.window
parent
Refers to either the parent WindowProxy, or itself.
It can rarely be null e.g. for contentWindow of an iframe that is already removed from the parent. Read more on MDN
let parent: WebAPI.DOMAPI.window
personalbar
Returns true if the personal bar is visible; otherwise, returns false. Read more on MDN
let personalbar: WebAPI.DOMAPI.barProp
postMessage
Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.
Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.
A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.
If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".
Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned. Read more on MDN
let postMessage: ( ~message: JSON.t, ~targetOrigin: string, ~transfer: array<Dict.t<string>>=?,) => unit
Parameters
JSON.t string option< array< Dict.t< string > > >Return type
unitpostMessage2
Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.
Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.
A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.
If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".
Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned. Read more on MDN
let postMessage2: ( ~message: JSON.t, ~options: WebAPI.DOMAPI.windowPostMessageOptions=?,) => unit
prompt
let prompt: (~message: string=?, ~default: string=?) => string
Parameters
option< string > option< string >Return type
stringqueueMicrotask
let queueMicrotask: WebAPI.DOMAPI.voidFunction => unit
removeEventListener
Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN
let removeEventListener: ( WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>, ~options: WebAPI.EventAPI.eventListenerOptions=?,) => unit
Parameters
WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener option< WebAPI.EventAPI.eventListenerOptions >Return type
unitremoveEventListener_useCapture
Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN
let removeEventListener_useCapture: ( WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>,) => unit
requestAnimationFrame
let requestAnimationFrame: WebAPI.DOMAPI.frameRequestCallback => int
requestIdleCallback
let requestIdleCallback: ( ~callback: WebAPI.DOMAPI.idleRequestCallback, ~options: WebAPI.DOMAPI.idleRequestOptions=?,) => int
Parameters
WebAPI.DOMAPI.idleRequestCallback option< WebAPI.DOMAPI.idleRequestOptions >Return type
intresizeBy
let resizeBy: (~x: int, ~y: int) => unit
Parameters
int intReturn type
unitresizeTo
let resizeTo: (~width: int, ~height: int) => unit
Parameters
int intReturn type
unitscroll
let scroll: (~options: WebAPI.DOMAPI.scrollToOptions=?) => unit
scroll2
let scroll2: (~x: float, ~y: float) => unit
Parameters
float floatReturn type
unitscrollbars
Returns true if the scrollbars are visible; otherwise, returns false. Read more on MDN
let scrollbars: WebAPI.DOMAPI.barProp
scrollBy
let scrollBy: (~options: WebAPI.DOMAPI.scrollToOptions=?) => unit
scrollBy2
let scrollBy2: (~x: float, ~y: float) => unit
Parameters
float floatReturn type
unitscrollTo
let scrollTo: (~options: WebAPI.DOMAPI.scrollToOptions=?) => unit
scrollTo2
let scrollTo2: (~x: float, ~y: float) => unit
Parameters
float floatReturn type
unitsetInterval
let setInterval: (~handler: string, ~timeout: int=?) => int
Parameters
string option< int >Return type
intsetInterval2
let setInterval2: (~handler: unit => unit, ~timeout: int=?) => int
Parameters
unit unit option< int >Return type
intsetTimeout
let setTimeout: (~handler: string, ~timeout: int=?) => int
Parameters
string option< int >Return type
intsetTimeout2
let setTimeout2: (~handler: unit => unit, ~timeout: int=?) => int
Parameters
unit unit option< int >Return type
intstatusbar
Returns true if the status bar is visible; otherwise, returns false. Read more on MDN
let statusbar: WebAPI.DOMAPI.barProp
stop
Cancels the document load. Read more on MDN
let stop: unit => unit
Parameters
unitReturn type
unitstructuredClone
let structuredClone: ( 't, ~options: WebAPI.ChannelMessagingAPI.structuredSerializeOptions=?,) => 't
toolbar
Returns true if the toolbar is visible; otherwise, returns false. Read more on MDN
let toolbar: WebAPI.DOMAPI.barProp