diff --git a/baselines/audioworklet.generated.d.ts b/baselines/audioworklet.generated.d.ts index ad208550c..79325af45 100644 --- a/baselines/audioworklet.generated.d.ts +++ b/baselines/audioworklet.generated.d.ts @@ -185,13 +185,13 @@ interface UnderlyingSource { */ interface AbortController { /** - * Returns the AbortSignal object associated with this object. + * The **`signal`** read-only property of the AbortController interface returns an AbortSignal object instance, which can be used to communicate with/abort an asynchronous operation as desired. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/signal) */ readonly signal: AbortSignal; /** - * Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted. + * The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort) */ @@ -214,16 +214,24 @@ interface AbortSignalEventMap { */ interface AbortSignal extends EventTarget { /** - * Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. + * The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (`true`) or not (`false`). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/aborted) */ readonly aborted: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */ onabort: ((this: AbortSignal, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason) */ + /** + * The **`reason`** read-only property returns a JavaScript value that indicates the abort reason. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason) + */ readonly reason: any; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted) */ + /** + * The **`throwIfAborted()`** method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted) + */ throwIfAborted(): void; addEventListener(type: K, listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -246,13 +254,29 @@ declare var AbortSignal: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope) */ interface AudioWorkletGlobalScope extends WorkletGlobalScope { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentFrame) */ + /** + * The read-only **`currentFrame`** property of the AudioWorkletGlobalScope interface returns an integer that represents the ever-increasing current sample-frame of the audio block being processed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentFrame) + */ readonly currentFrame: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentTime) */ + /** + * The read-only **`currentTime`** property of the AudioWorkletGlobalScope interface returns a double that represents the ever-increasing context time of the audio block being processed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentTime) + */ readonly currentTime: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/sampleRate) */ + /** + * The read-only **`sampleRate`** property of the AudioWorkletGlobalScope interface returns a float that represents the sample rate of the associated BaseAudioContext the worklet belongs to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/sampleRate) + */ readonly sampleRate: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/registerProcessor) */ + /** + * The **`registerProcessor`** method of the from AudioWorkletProcessor interface under a specified _name_. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/registerProcessor) + */ registerProcessor(name: string, processorCtor: AudioWorkletProcessorConstructor): void; } @@ -267,7 +291,11 @@ declare var AudioWorkletGlobalScope: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletProcessor) */ interface AudioWorkletProcessor { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletProcessor/port) */ + /** + * The read-only **`port`** property of the The MessagePort object that is connecting the `AudioWorkletProcessor` and the associated `AudioWorkletNode`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletProcessor/port) + */ readonly port: MessagePort; } @@ -286,9 +314,17 @@ interface AudioWorkletProcessorImpl extends AudioWorkletProcessor { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy) */ interface ByteLengthQueuingStrategy extends QueuingStrategy { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/highWaterMark) */ + /** + * The read-only **`ByteLengthQueuingStrategy.highWaterMark`** property returns the total number of bytes that can be contained in the internal queue before backpressure is applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/highWaterMark) + */ readonly highWaterMark: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/size) */ + /** + * The **`size()`** method of the `byteLength` property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/size) + */ readonly size: QueuingStrategySize; } @@ -318,9 +354,17 @@ declare var CompressionStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy) */ interface CountQueuingStrategy extends QueuingStrategy { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/highWaterMark) */ + /** + * The read-only **`CountQueuingStrategy.highWaterMark`** property returns the total number of chunks that can be contained in the internal queue before backpressure is applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/highWaterMark) + */ readonly highWaterMark: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/size) */ + /** + * The **`size()`** method of the total queue size is a count of the number of chunks in the queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/size) + */ readonly size: QueuingStrategySize; } @@ -336,12 +380,13 @@ declare var CountQueuingStrategy: { */ interface CustomEvent extends Event { /** - * Returns any custom data event was created with. Typically used for synthetic events. + * The read-only **`detail`** property of the CustomEvent interface returns any data passed when initializing the event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) */ readonly detail: T; /** + * The **`CustomEvent.initCustomEvent()`** method initializes a CustomEvent object. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/initCustomEvent) @@ -361,14 +406,23 @@ declare var CustomEvent: { */ interface DOMException extends Error { /** + * The **`code`** read-only property of the DOMException interface returns one of the legacy error code constants, or `0` if none match. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/code) */ readonly code: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message) */ + /** + * The **`message`** read-only property of the a message or description associated with the given error name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message) + */ readonly message: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name) */ + /** + * The **`name`** read-only property of the one of the strings associated with an error name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name) + */ readonly name: string; readonly INDEX_SIZE_ERR: 1; readonly DOMSTRING_SIZE_ERR: 2; @@ -448,15 +502,35 @@ declare var DecompressionStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent) */ interface ErrorEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno) */ + /** + * The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno) + */ readonly colno: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/error) */ + /** + * The **`error`** read-only property of the ErrorEvent interface returns a JavaScript value, such as an Error or DOMException, representing the error associated with this event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/error) + */ readonly error: any; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename) */ + /** + * The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename) + */ readonly filename: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno) */ + /** + * The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno) + */ readonly lineno: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message) */ + /** + * The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message) + */ readonly message: string; } @@ -472,109 +546,113 @@ declare var ErrorEvent: { */ interface Event { /** - * Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise. + * The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles) */ readonly bubbles: boolean; /** + * The **`cancelBubble`** property of the Event interface is deprecated. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble) */ cancelBubble: boolean; /** - * Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method. + * The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable) */ readonly cancelable: boolean; /** - * Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise. + * The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed) */ readonly composed: boolean; /** - * Returns the object whose event listener's callback is currently being invoked. + * The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget) */ readonly currentTarget: EventTarget | null; /** - * Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. + * The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented) */ readonly defaultPrevented: boolean; /** - * Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. + * The **`eventPhase`** read-only property of the being evaluated. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase) */ readonly eventPhase: number; /** - * Returns true if event was dispatched by the user agent, and false otherwise. + * The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted) */ readonly isTrusted: boolean; /** + * The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue) */ returnValue: boolean; /** + * The deprecated **`Event.srcElement`** is an alias for the Event.target property. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement) */ readonly srcElement: EventTarget | null; /** - * Returns the object to which event is dispatched (its target). + * The read-only **`target`** property of the dispatched. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target) */ readonly target: EventTarget | null; /** - * Returns the event's timestamp as the number of milliseconds measured relative to the time origin. + * The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp) */ readonly timeStamp: DOMHighResTimeStamp; /** - * Returns the type of event, e.g. "click", "hashchange", or "submit". + * The **`type`** read-only property of the Event interface returns a string containing the event's type. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type) */ readonly type: string; /** - * Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget. + * The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath) */ composedPath(): EventTarget[]; /** + * The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent(). * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent) */ initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void; /** - * If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled. + * The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault) */ preventDefault(): void; /** - * Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects. + * The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation) */ stopImmediatePropagation(): void; /** - * When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object. + * The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation) */ @@ -609,31 +687,19 @@ interface EventListenerObject { */ interface EventTarget { /** - * 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. + * The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener) */ addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: AddEventListenerOptions | boolean): void; /** - * 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. + * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) */ dispatchEvent(event: Event): boolean; /** - * Removes the event listener in target's event listener list with the same type, callback, and options. + * The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener) */ @@ -659,31 +725,31 @@ interface GenericTransformStream { */ interface MessageEvent extends Event { /** - * Returns the data of the message. + * The **`data`** read-only property of the The data sent by the message emitter; this can be any data type, depending on what originated this event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data) */ readonly data: T; /** - * Returns the last event ID string, for server-sent events. + * The **`lastEventId`** read-only property of the unique ID for the event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId) */ readonly lastEventId: string; /** - * Returns the origin of the message, for server-sent events and cross-document messaging. + * The **`origin`** read-only property of the origin of the message emitter. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin) */ readonly origin: string; /** - * Returns the MessagePort array sent with the message, for cross-document messaging and channel messaging. + * The **`ports`** read-only property of the containing all MessagePort objects sent with the message, in order. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports) */ readonly ports: ReadonlyArray; /** - * Returns the WindowProxy of the source window, for cross-document messaging, and the MessagePort being attached, in the connect event fired at SharedWorkerGlobalScope objects. + * The **`source`** read-only property of the a WindowProxy, MessagePort, or a `MessageEventSource` (which can be a WindowProxy, message emitter. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source) */ @@ -725,22 +791,20 @@ interface MessagePortEventMap extends MessageEventTargetEventMap { */ interface MessagePort extends EventTarget, MessageEventTarget { /** - * Disconnects the port, so that it is no longer active. + * The **`close()`** method of the MessagePort interface disconnects the port, so it is no longer active. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/close) */ close(): void; /** - * Posts a message through the channel. Objects listed in transfer are transferred, not just cloned, meaning that they are no longer usable on the sending side. - * - * Throws a "DataCloneError" DOMException if transfer contains duplicate objects or port, or if message could not be cloned. + * The **`postMessage()`** method of the transfers ownership of objects to other browsing contexts. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage) */ postMessage(message: any, transfer: Transferable[]): void; postMessage(message: any, options?: StructuredSerializeOptions): void; /** - * Begins dispatching messages received on the port. + * The **`start()`** method of the MessagePort interface starts the sending of messages queued on the port. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/start) */ @@ -762,9 +826,17 @@ declare var MessagePort: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent) */ interface PromiseRejectionEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/promise) */ + /** + * The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript rejected. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/promise) + */ readonly promise: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/reason) */ + /** + * The PromiseRejectionEvent **`reason`** read-only property is any JavaScript value or Object which provides the reason passed into Promise.reject(). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/reason) + */ readonly reason: any; } @@ -779,15 +851,35 @@ declare var PromiseRejectionEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController) */ interface ReadableByteStreamController { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest) */ + /** + * The **`byobRequest`** read-only property of the ReadableByteStreamController interface returns the current BYOB request, or `null` if there are no pending requests. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest) + */ readonly byobRequest: ReadableStreamBYOBRequest | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/desiredSize) */ + /** + * The **`desiredSize`** read-only property of the ReadableByteStreamController interface returns the number of bytes required to fill the stream's internal queue to its 'desired size'. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/desiredSize) + */ readonly desiredSize: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) */ + /** + * The **`close()`** method of the ReadableByteStreamController interface closes the associated stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) + */ close(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) */ + /** + * The **`enqueue()`** method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is copied into the stream's internal queues). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) + */ enqueue(chunk: ArrayBufferView): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) */ + /** + * The **`error()`** method of the ReadableByteStreamController interface causes any future interactions with the associated stream to error with the specified reason. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) + */ error(e?: any): void; } @@ -802,19 +894,43 @@ declare var ReadableByteStreamController: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream) */ interface ReadableStream { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/locked) */ + /** + * The **`locked`** read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/locked) + */ readonly locked: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) */ + /** + * The **`cancel()`** method of the ReadableStream interface returns a Promise that resolves when the stream is canceled. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) + */ cancel(reason?: any): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) */ + /** + * The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) + */ getReader(options: { mode: "byob" }): ReadableStreamBYOBReader; getReader(): ReadableStreamDefaultReader; getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) */ + /** + * The **`pipeThrough()`** method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) + */ pipeThrough(transform: ReadableWritablePair, options?: StreamPipeOptions): ReadableStream; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) */ + /** + * The **`pipeTo()`** method of the ReadableStream interface pipes the current `ReadableStream` to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) + */ pipeTo(destination: WritableStream, options?: StreamPipeOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) */ + /** + * The **`tee()`** method of the two-element array containing the two resulting branches as new ReadableStream instances. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) + */ tee(): [ReadableStream, ReadableStream]; } @@ -831,9 +947,17 @@ declare var ReadableStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) */ interface ReadableStreamBYOBReader extends ReadableStreamGenericReader { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) */ + /** + * The **`read()`** method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) + */ read(view: T): Promise>; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) */ + /** + * The **`releaseLock()`** method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) + */ releaseLock(): void; } @@ -848,11 +972,23 @@ declare var ReadableStreamBYOBReader: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest) */ interface ReadableStreamBYOBRequest { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view) */ + /** + * The **`view`** getter property of the ReadableStreamBYOBRequest interface returns the current view. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view) + */ readonly view: ArrayBufferView | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) */ + /** + * The **`respond()`** method of the ReadableStreamBYOBRequest interface is used to signal to the associated readable byte stream that the specified number of bytes were written into the ReadableStreamBYOBRequest.view. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) + */ respond(bytesWritten: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) */ + /** + * The **`respondWithNewView()`** method of the ReadableStreamBYOBRequest interface specifies a new view that the consumer of the associated readable byte stream should write to instead of ReadableStreamBYOBRequest.view. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) + */ respondWithNewView(view: ArrayBufferView): void; } @@ -867,13 +1003,29 @@ declare var ReadableStreamBYOBRequest: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController) */ interface ReadableStreamDefaultController { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize) */ + /** + * The **`desiredSize`** read-only property of the required to fill the stream's internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize) + */ readonly desiredSize: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) */ + /** + * The **`close()`** method of the ReadableStreamDefaultController interface closes the associated stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) + */ close(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) */ + /** + * The **`enqueue()`** method of the ```js-nolint enqueue(chunk) ``` - `chunk` - : The chunk to enqueue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) + */ enqueue(chunk?: R): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) */ + /** + * The **`error()`** method of the with the associated stream to error. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) + */ error(e?: any): void; } @@ -888,9 +1040,17 @@ declare var ReadableStreamDefaultController: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader) */ interface ReadableStreamDefaultReader extends ReadableStreamGenericReader { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) */ + /** + * The **`read()`** method of the ReadableStreamDefaultReader interface returns a Promise providing access to the next chunk in the stream's internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) + */ read(): Promise>; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) */ + /** + * The **`releaseLock()`** method of the ReadableStreamDefaultReader interface releases the reader's lock on the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) + */ releaseLock(): void; } @@ -913,17 +1073,7 @@ interface ReadableStreamGenericReader { */ interface TextDecoder extends TextDecoderCommon { /** - * Returns the result of running encoding's decoder. The method can be invoked zero or more times with options's stream set to true, and then once without options's stream (or set to false), to process a fragmented input. If the invocation without options's stream (or set to false) has no input, it's clearest to omit both arguments. - * - * ``` - * var string = "", decoder = new TextDecoder(encoding), buffer; - * while(buffer = next_chunk()) { - * string += decoder.decode(buffer, {stream:true}); - * } - * string += decoder.decode(); // end-of-queue - * ``` - * - * If the error mode is "fatal" and encoding's decoder returns error, throws a TypeError. + * The **`TextDecoder.decode()`** method returns a string containing text decoded from the buffer passed as a parameter. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoder/decode) */ @@ -978,13 +1128,13 @@ declare var TextDecoderStream: { */ interface TextEncoder extends TextEncoderCommon { /** - * Returns the result of running UTF-8's encoder. + * The **`TextEncoder.encode()`** method takes a string as input, and returns a Global_Objects/Uint8Array containing the text given in parameters encoded with the specific method for that TextEncoder object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encode) */ encode(input?: string): Uint8Array; /** - * Runs the UTF-8 encoder on source, stores the result of that operation into destination, and returns the progress made as an object wherein read is the number of converted code units of source and written is the number of bytes modified in destination. + * The **`TextEncoder.encodeInto()`** method takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into, and returns a dictionary object indicating the progress of the encoding. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encodeInto) */ @@ -1026,9 +1176,17 @@ declare var TextEncoderStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream) */ interface TransformStream { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/readable) */ + /** + * The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this `TransformStream`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/readable) + */ readonly readable: ReadableStream; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/writable) */ + /** + * The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this `TransformStream`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/writable) + */ readonly writable: WritableStream; } @@ -1043,13 +1201,29 @@ declare var TransformStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController) */ interface TransformStreamDefaultController { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/desiredSize) */ + /** + * The **`desiredSize`** read-only property of the TransformStreamDefaultController interface returns the desired size to fill the queue of the associated ReadableStream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/desiredSize) + */ readonly desiredSize: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/enqueue) */ + /** + * The **`enqueue()`** method of the TransformStreamDefaultController interface enqueues the given chunk in the readable side of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/enqueue) + */ enqueue(chunk?: O): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/error) */ + /** + * The **`error()`** method of the TransformStreamDefaultController interface errors both sides of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/error) + */ error(reason?: any): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/terminate) */ + /** + * The **`terminate()`** method of the TransformStreamDefaultController interface closes the readable side and errors the writable side of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/terminate) + */ terminate(): void; } @@ -1064,32 +1238,84 @@ declare var TransformStreamDefaultController: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL) */ interface URL { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash) */ + /** + * The **`hash`** property of the URL interface is a string containing a `'#'` followed by the fragment identifier of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash) + */ hash: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host) */ + /** + * The **`host`** property of the URL interface is a string containing the host, which is the URL.hostname, and then, if the port of the URL is nonempty, a `':'`, followed by the URL.port of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host) + */ host: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname) */ + /** + * The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname) + */ hostname: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/href) */ + /** + * The **`href`** property of the URL interface is a string containing the whole URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/href) + */ href: string; toString(): string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/origin) */ + /** + * The **`origin`** read-only property of the URL interface returns a string containing the Unicode serialization of the origin of the represented URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/origin) + */ readonly origin: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password) */ + /** + * The **`password`** property of the URL interface is a string containing the password component of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password) + */ password: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname) */ + /** + * The **`pathname`** property of the URL interface represents a location in a hierarchical structure. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname) + */ pathname: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port) */ + /** + * The **`port`** property of the URL interface is a string containing the port number of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port) + */ port: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol) */ + /** + * The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final `':'`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol) + */ protocol: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search) */ + /** + * The **`search`** property of the URL interface is a search string, also called a _query string_, that is a string containing a `'?'` followed by the parameters of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search) + */ search: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/searchParams) */ + /** + * The **`searchParams`** read-only property of the access to the [MISSING: httpmethod('GET')] decoded query arguments contained in the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/searchParams) + */ readonly searchParams: URLSearchParams; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username) */ + /** + * The **`username`** property of the URL interface is a string containing the username component of the URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username) + */ username: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/toJSON) */ + /** + * The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as ```js-nolint toJSON() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/toJSON) + */ toJSON(): string; } @@ -1108,47 +1334,54 @@ declare var URL: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams) */ interface URLSearchParams { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/size) */ + /** + * The **`size`** read-only property of the URLSearchParams interface indicates the total number of search parameter entries. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/size) + */ readonly size: number; /** - * Appends a specified key/value pair as a new search parameter. + * The **`append()`** method of the URLSearchParams interface appends a specified key/value pair as a new search parameter. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/append) */ append(name: string, value: string): void; /** - * Deletes the given search parameter, and its associated value, from the list of all search parameters. + * The **`delete()`** method of the URLSearchParams interface deletes specified parameters and their associated value(s) from the list of all search parameters. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/delete) */ delete(name: string, value?: string): void; /** - * Returns the first value associated to the given search parameter. + * The **`get()`** method of the URLSearchParams interface returns the first value associated to the given search parameter. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/get) */ get(name: string): string | null; /** - * Returns all the values association with a given search parameter. + * The **`getAll()`** method of the URLSearchParams interface returns all the values associated with a given search parameter as an array. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/getAll) */ getAll(name: string): string[]; /** - * Returns a Boolean indicating if such a search parameter exists. + * The **`has()`** method of the URLSearchParams interface returns a boolean value that indicates whether the specified parameter is in the search parameters. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/has) */ has(name: string, value?: string): boolean; /** - * Sets the value associated to a given search parameter to the given value. If there were several values, delete the others. + * The **`set()`** method of the URLSearchParams interface sets the value associated with a given search parameter to the given value. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/set) */ set(name: string, value: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort) */ + /** + * The **`URLSearchParams.sort()`** method sorts all key/value pairs contained in this object in place and returns `undefined`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort) + */ sort(): void; - /** Returns a string containing a query string suitable for use in a URL. Does not include the question mark. */ toString(): string; forEach(callbackfn: (value: string, key: string, parent: URLSearchParams) => void, thisArg?: any): void; } @@ -1178,13 +1411,29 @@ declare var WorkletGlobalScope: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream) */ interface WritableStream { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) */ + /** + * The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the `WritableStream` is locked to a writer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) + */ readonly locked: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) */ + /** + * The **`abort()`** method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) + */ abort(reason?: any): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) */ + /** + * The **`close()`** method of the WritableStream interface closes the associated stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) + */ close(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) */ + /** + * The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) + */ getWriter(): WritableStreamDefaultWriter; } @@ -1199,9 +1448,17 @@ declare var WritableStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController) */ interface WritableStreamDefaultController { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/signal) */ + /** + * The read-only **`signal`** property of the WritableStreamDefaultController interface returns the AbortSignal associated with the controller. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/signal) + */ readonly signal: AbortSignal; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) */ + /** + * The **`error()`** method of the with the associated stream to error. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) + */ error(e?: any): void; } @@ -1216,19 +1473,47 @@ declare var WritableStreamDefaultController: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter) */ interface WritableStreamDefaultWriter { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) */ + /** + * The **`closed`** read-only property of the the stream errors or the writer's lock is released. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) + */ readonly closed: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) */ + /** + * The **`desiredSize`** read-only property of the to fill the stream's internal queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) + */ readonly desiredSize: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */ + /** + * The **`ready`** read-only property of the that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) + */ readonly ready: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */ + /** + * The **`abort()`** method of the the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) + */ abort(reason?: any): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */ + /** + * The **`close()`** method of the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) + */ close(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) */ + /** + * The **`releaseLock()`** method of the corresponding stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) + */ releaseLock(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) */ + /** + * The **`write()`** method of the operation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) + */ write(chunk?: W): Promise; } @@ -1490,13 +1775,29 @@ interface UnderlyingSourceStartCallback { (controller: ReadableStreamController): any; } -/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentFrame) */ +/** + * The read-only **`currentFrame`** property of the AudioWorkletGlobalScope interface returns an integer that represents the ever-increasing current sample-frame of the audio block being processed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentFrame) + */ declare var currentFrame: number; -/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentTime) */ +/** + * The read-only **`currentTime`** property of the AudioWorkletGlobalScope interface returns a double that represents the ever-increasing context time of the audio block being processed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/currentTime) + */ declare var currentTime: number; -/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/sampleRate) */ +/** + * The read-only **`sampleRate`** property of the AudioWorkletGlobalScope interface returns a float that represents the sample rate of the associated BaseAudioContext the worklet belongs to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/sampleRate) + */ declare var sampleRate: number; -/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/registerProcessor) */ +/** + * The **`registerProcessor`** method of the from AudioWorkletProcessor interface under a specified _name_. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/registerProcessor) + */ declare function registerProcessor(name: string, processorCtor: AudioWorkletProcessorConstructor): void; type AllowSharedBufferSource = ArrayBufferLike | ArrayBufferView; type BufferSource = ArrayBufferView | ArrayBuffer; diff --git a/baselines/dom.generated.d.ts b/baselines/dom.generated.d.ts index 3c799d012..d3337da8f 100644 --- a/baselines/dom.generated.d.ts +++ b/baselines/dom.generated.d.ts @@ -2507,11 +2507,23 @@ type XPathNSResolver = ((prefix: string | null) => string | null) | { lookupName * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays) */ interface ANGLE_instanced_arrays { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays/drawArraysInstancedANGLE) */ + /** + * The **`ANGLE_instanced_arrays.drawArraysInstancedANGLE()`** method of the WebGL API renders primitives from array data like the WebGLRenderingContext.drawArrays() method. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays/drawArraysInstancedANGLE) + */ drawArraysInstancedANGLE(mode: GLenum, first: GLint, count: GLsizei, primcount: GLsizei): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays/drawElementsInstancedANGLE) */ + /** + * The **`ANGLE_instanced_arrays.drawElementsInstancedANGLE()`** method of the WebGL API renders primitives from array data like the WebGLRenderingContext.drawElements() method. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays/drawElementsInstancedANGLE) + */ drawElementsInstancedANGLE(mode: GLenum, count: GLsizei, type: GLenum, offset: GLintptr, primcount: GLsizei): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays/vertexAttribDivisorANGLE) */ + /** + * The **ANGLE_instanced_arrays.vertexAttribDivisorANGLE()** method of the WebGL API modifies the rate at which generic vertex attributes advance when rendering multiple instances of primitives with ANGLE_instanced_arrays.drawArraysInstancedANGLE() and ANGLE_instanced_arrays.drawElementsInstancedANGLE(). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ANGLE_instanced_arrays/vertexAttribDivisorANGLE) + */ vertexAttribDivisorANGLE(index: GLuint, divisor: GLuint): void; readonly VERTEX_ATTRIB_ARRAY_DIVISOR_ANGLE: 0x88FE; } @@ -2622,13 +2634,13 @@ interface ARIAMixin { */ interface AbortController { /** - * Returns the AbortSignal object associated with this object. + * The **`signal`** read-only property of the AbortController interface returns an AbortSignal object instance, which can be used to communicate with/abort an asynchronous operation as desired. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/signal) */ readonly signal: AbortSignal; /** - * Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted. + * The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort) */ @@ -2651,16 +2663,24 @@ interface AbortSignalEventMap { */ interface AbortSignal extends EventTarget { /** - * Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. + * The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (`true`) or not (`false`). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/aborted) */ readonly aborted: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */ onabort: ((this: AbortSignal, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason) */ + /** + * The **`reason`** read-only property returns a JavaScript value that indicates the abort reason. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason) + */ readonly reason: any; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted) */ + /** + * The **`throwIfAborted()`** method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted) + */ throwIfAborted(): void; addEventListener(type: K, listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -2686,31 +2706,31 @@ declare var AbortSignal: { */ interface AbstractRange { /** - * Returns true if range is collapsed, and false otherwise. + * The read-only **`collapsed`** property of the AbstractRange interface returns `true` if the range's start position and end position are the same. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbstractRange/collapsed) */ readonly collapsed: boolean; /** - * Returns range's end node. + * The read-only **`endContainer`** property of the AbstractRange interface returns the Node in which the end of the range is located. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbstractRange/endContainer) */ readonly endContainer: Node; /** - * Returns range's end offset. + * The **`endOffset`** property of the AbstractRange interface returns the offset into the end node of the range's end position. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbstractRange/endOffset) */ readonly endOffset: number; /** - * Returns range's start node. + * The read-only **`startContainer`** property of the AbstractRange interface returns the start Node for the range. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbstractRange/startContainer) */ readonly startContainer: Node; /** - * Returns range's start offset. + * The read-only **`startOffset`** property of the AbstractRange interface returns the offset into the start node of the range's start position. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbstractRange/startOffset) */ @@ -2741,23 +2761,59 @@ interface AbstractWorker { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode) */ interface AnalyserNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/fftSize) */ + /** + * The **`fftSize`** property of the AnalyserNode interface is an unsigned long value and represents the window size in samples that is used when performing a Fast Fourier Transform (FFT) to get frequency domain data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/fftSize) + */ fftSize: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/frequencyBinCount) */ + /** + * The **`frequencyBinCount`** read-only property of the AnalyserNode interface contains the total number of data points available to AudioContext BaseAudioContext.sampleRate. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/frequencyBinCount) + */ readonly frequencyBinCount: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/maxDecibels) */ + /** + * The **`maxDecibels`** property of the AnalyserNode interface is a double value representing the maximum power value in the scaling range for the FFT analysis data, for conversion to unsigned byte values โ€” basically, this specifies the maximum value for the range of results when using `getByteFrequencyData()`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/maxDecibels) + */ maxDecibels: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/minDecibels) */ + /** + * The **`minDecibels`** property of the AnalyserNode interface is a double value representing the minimum power value in the scaling range for the FFT analysis data, for conversion to unsigned byte values โ€” basically, this specifies the minimum value for the range of results when using `getByteFrequencyData()`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/minDecibels) + */ minDecibels: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/smoothingTimeConstant) */ + /** + * The **`smoothingTimeConstant`** property of the AnalyserNode interface is a double value representing the averaging constant with the last analysis frame. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/smoothingTimeConstant) + */ smoothingTimeConstant: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getByteFrequencyData) */ + /** + * The **`getByteFrequencyData()`** method of the AnalyserNode interface copies the current frequency data into a Uint8Array (unsigned byte array) passed into it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getByteFrequencyData) + */ getByteFrequencyData(array: Uint8Array): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getByteTimeDomainData) */ + /** + * The **`getByteTimeDomainData()`** method of the AnalyserNode Interface copies the current waveform, or time-domain, data into a Uint8Array (unsigned byte array) passed into it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getByteTimeDomainData) + */ getByteTimeDomainData(array: Uint8Array): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getFloatFrequencyData) */ + /** + * The **`getFloatFrequencyData()`** method of the AnalyserNode Interface copies the current frequency data into a Float32Array array passed into it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getFloatFrequencyData) + */ getFloatFrequencyData(array: Float32Array): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getFloatTimeDomainData) */ + /** + * The **`getFloatTimeDomainData()`** method of the AnalyserNode Interface copies the current waveform, or time-domain, data into a Float32Array array passed into it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnalyserNode/getFloatTimeDomainData) + */ getFloatTimeDomainData(array: Float32Array): void; } @@ -2785,13 +2841,29 @@ interface AnimationEventMap { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation) */ interface Animation extends EventTarget { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/currentTime) */ + /** + * The **`Animation.currentTime`** property of the Web Animations API returns and sets the current time value of the animation in milliseconds, whether running or paused. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/currentTime) + */ currentTime: CSSNumberish | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/effect) */ + /** + * The **`Animation.effect`** property of the Web Animations API gets and sets the target effect of an animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/effect) + */ effect: AnimationEffect | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/finished) */ + /** + * The **`Animation.finished`** read-only property of the Web Animations API returns a Promise which resolves once the animation has finished playing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/finished) + */ readonly finished: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/id) */ + /** + * The **`Animation.id`** property of the Web Animations API returns or sets a string used to identify the animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/id) + */ id: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/cancel_event) */ oncancel: ((this: Animation, ev: AnimationPlaybackEvent) => any) | null; @@ -2799,35 +2871,95 @@ interface Animation extends EventTarget { onfinish: ((this: Animation, ev: AnimationPlaybackEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/remove_event) */ onremove: ((this: Animation, ev: AnimationPlaybackEvent) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/pending) */ + /** + * The read-only **`Animation.pending`** property of the Web Animations API indicates whether the animation is currently waiting for an asynchronous operation such as initiating playback or pausing a running animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/pending) + */ readonly pending: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/playState) */ + /** + * The read-only **`Animation.playState`** property of the Web Animations API returns an enumerated value describing the playback state of an animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/playState) + */ readonly playState: AnimationPlayState; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/playbackRate) */ + /** + * The **`Animation.playbackRate`** property of the Web Animations API returns or sets the playback rate of the animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/playbackRate) + */ playbackRate: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/ready) */ + /** + * The read-only **`Animation.ready`** property of the Web Animations API returns a Promise which resolves when the animation is ready to play. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/ready) + */ readonly ready: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/replaceState) */ + /** + * The read-only **`Animation.replaceState`** property of the Web Animations API indicates whether the animation has been removed by the browser automatically after being replaced by another animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/replaceState) + */ readonly replaceState: AnimationReplaceState; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/startTime) */ + /** + * The **`Animation.startTime`** property of the Animation interface is a double-precision floating-point value which indicates the scheduled time when an animation's playback should begin. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/startTime) + */ startTime: CSSNumberish | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/timeline) */ + /** + * The **`Animation.timeline`** property of the Animation interface returns or sets the AnimationTimeline associated with this animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/timeline) + */ timeline: AnimationTimeline | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/cancel) */ + /** + * The Web Animations API's **`cancel()`** method of the Animation interface clears all KeyframeEffects caused by this animation and aborts its playback. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/cancel) + */ cancel(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/commitStyles) */ + /** + * The `commitStyles()` method of the Web Animations API's Animation interface writes the computed values of the animation's current styles into its target element's `style` attribute. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/commitStyles) + */ commitStyles(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/finish) */ + /** + * The **`finish()`** method of the Web Animations API's Animation Interface sets the current playback time to the end of the animation corresponding to the current playback direction. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/finish) + */ finish(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/pause) */ + /** + * The **`pause()`** method of the Web Animations API's Animation interface suspends playback of the animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/pause) + */ pause(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/persist) */ + /** + * The `persist()` method of the Web Animations API's Animation interface explicitly persists an animation, preventing it from being automatically removed when it is replaced by another animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/persist) + */ persist(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/play) */ + /** + * The **`play()`** method of the Web Animations API's Animation Interface starts or resumes playing of an animation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/play) + */ play(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/reverse) */ + /** + * The **`Animation.reverse()`** method of the Animation Interface reverses the playback direction, meaning the animation ends at its beginning. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/reverse) + */ reverse(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/updatePlaybackRate) */ + /** + * The **`updatePlaybackRate()`** method of the Web Animations API's synchronizing its playback position. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Animation/updatePlaybackRate) + */ updatePlaybackRate(playbackRate: number): void; addEventListener(type: K, listener: (this: Animation, ev: AnimationEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -2846,11 +2978,23 @@ declare var Animation: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect) */ interface AnimationEffect { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect/getComputedTiming) */ + /** + * The `getComputedTiming()` method of the AnimationEffect interface returns the calculated timing properties for this animation effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect/getComputedTiming) + */ getComputedTiming(): ComputedEffectTiming; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect/getTiming) */ + /** + * The `AnimationEffect.getTiming()` method of the AnimationEffect interface returns an object containing the timing properties for the Animation Effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect/getTiming) + */ getTiming(): EffectTiming; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect/updateTiming) */ + /** + * The `updateTiming()` method of the AnimationEffect interface updates the specified timing properties for an animation effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEffect/updateTiming) + */ updateTiming(timing?: OptionalEffectTiming): void; } @@ -2865,11 +3009,23 @@ declare var AnimationEffect: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent) */ interface AnimationEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent/animationName) */ + /** + * The **`AnimationEvent.animationName`** read-only property is a string containing the value of the animation-name CSS property associated with the transition. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent/animationName) + */ readonly animationName: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent/elapsedTime) */ + /** + * The **`AnimationEvent.elapsedTime`** read-only property is a `float` giving the amount of time the animation has been running, in seconds, when this event fired, excluding any time the animation was paused. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent/elapsedTime) + */ readonly elapsedTime: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent/pseudoElement) */ + /** + * The **`AnimationEvent.pseudoElement`** read-only property is a string, starting with `'::'`, containing the name of the pseudo-element the animation runs on. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationEvent/pseudoElement) + */ readonly pseudoElement: string; } @@ -2891,9 +3047,17 @@ interface AnimationFrameProvider { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent) */ interface AnimationPlaybackEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent/currentTime) */ + /** + * The **`currentTime`** read-only property of the AnimationPlaybackEvent interface represents the current time of the animation that generated the event at the moment the event is queued. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent/currentTime) + */ readonly currentTime: CSSNumberish | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent/timelineTime) */ + /** + * The **`timelineTime`** read-only property of the AnimationPlaybackEvent interface represents the time value of the animation's AnimationTimeline at the moment the event is queued. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent/timelineTime) + */ readonly timelineTime: CSSNumberish | null; } @@ -2908,7 +3072,11 @@ declare var AnimationPlaybackEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationTimeline) */ interface AnimationTimeline { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationTimeline/currentTime) */ + /** + * The **`currentTime`** read-only property of the Web Animations API's AnimationTimeline interface returns the timeline's current time in milliseconds, or `null` if the timeline is inactive. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationTimeline/currentTime) + */ readonly currentTime: CSSNumberish | null; } @@ -2923,24 +3091,49 @@ declare var AnimationTimeline: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr) */ interface Attr extends Node { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/localName) */ + /** + * The read-only **`localName`** property of the Attr interface returns the _local part_ of the _qualified name_ of an attribute, that is the name of the attribute, stripped from any namespace in front of it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/localName) + */ readonly localName: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/name) */ + /** + * The read-only **`name`** property of the Attr interface returns the _qualified name_ of an attribute, that is the name of the attribute, with the namespace prefix, if any, in front of it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/namespaceURI) */ + /** + * The read-only **`namespaceURI`** property of the Attr interface returns the namespace URI of the attribute, or `null` if the element is not in a namespace. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/namespaceURI) + */ readonly namespaceURI: string | null; readonly ownerDocument: Document; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/ownerElement) */ + /** + * The read-only **`ownerElement`** property of the Attr interface returns the Element the attribute belongs to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/ownerElement) + */ readonly ownerElement: Element | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/prefix) */ + /** + * The read-only **`prefix`** property of the Attr returns the namespace prefix of the attribute, or `null` if no prefix is specified. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/prefix) + */ readonly prefix: string | null; /** + * The read-only **`specified`** property of the Attr interface always returns `true`. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/specified) */ readonly specified: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/value) */ + /** + * The **`value`** property of the Attr interface contains the value of the attribute. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Attr/value) + */ value: string; } @@ -2955,19 +3148,47 @@ declare var Attr: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer) */ interface AudioBuffer { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/duration) */ + /** + * The **`duration`** property of the AudioBuffer interface returns a double representing the duration, in seconds, of the PCM data stored in the buffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/duration) + */ readonly duration: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/length) */ + /** + * The **`length`** property of the AudioBuffer interface returns an integer representing the length, in sample-frames, of the PCM data stored in the buffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/length) + */ readonly length: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/numberOfChannels) */ + /** + * The `numberOfChannels` property of the AudioBuffer interface returns an integer representing the number of discrete audio channels described by the PCM data stored in the buffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/numberOfChannels) + */ readonly numberOfChannels: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/sampleRate) */ + /** + * The **`sampleRate`** property of the AudioBuffer interface returns a float representing the sample rate, in samples per second, of the PCM data stored in the buffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/sampleRate) + */ readonly sampleRate: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/copyFromChannel) */ + /** + * The **`copyFromChannel()`** method of the channel of the `AudioBuffer` to a specified ```js-nolint copyFromChannel(destination, channelNumber, startInChannel) ``` - `destination` - : A Float32Array to copy the channel's samples to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/copyFromChannel) + */ copyFromChannel(destination: Float32Array, channelNumber: number, bufferOffset?: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/copyToChannel) */ + /** + * The `copyToChannel()` method of the AudioBuffer interface copies the samples to the specified channel of the `AudioBuffer`, from the source array. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/copyToChannel) + */ copyToChannel(source: Float32Array, channelNumber: number, bufferOffset?: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/getChannelData) */ + /** + * The **`getChannelData()`** method of the AudioBuffer Interface returns a Float32Array containing the PCM data associated with the channel, defined by the channel parameter (with 0 representing the first channel). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBuffer/getChannelData) + */ getChannelData(channel: number): Float32Array; } @@ -2982,19 +3203,47 @@ declare var AudioBuffer: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode) */ interface AudioBufferSourceNode extends AudioScheduledSourceNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/buffer) */ + /** + * The **`buffer`** property of the AudioBufferSourceNode interface provides the ability to play back audio using an AudioBuffer as the source of the sound data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/buffer) + */ buffer: AudioBuffer | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/detune) */ + /** + * The **`detune`** property of the representing detuning of oscillation in cents. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/detune) + */ readonly detune: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loop) */ + /** + * The `loop` property of the AudioBufferSourceNode interface is a Boolean indicating if the audio asset must be replayed when the end of the AudioBuffer is reached. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loop) + */ loop: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loopEnd) */ + /** + * The `loopEnd` property of the AudioBufferSourceNode interface specifies is a floating point number specifying, in seconds, at what offset into playing the AudioBuffer playback should loop back to the time indicated by the AudioBufferSourceNode.loopStart property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loopEnd) + */ loopEnd: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loopStart) */ + /** + * The **`loopStart`** property of the AudioBufferSourceNode interface is a floating-point value indicating, in seconds, where in the AudioBuffer the restart of the play must happen. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loopStart) + */ loopStart: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/playbackRate) */ + /** + * The **`playbackRate`** property of the AudioBufferSourceNode interface Is a k-rate AudioParam that defines the speed at which the audio asset will be played. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/playbackRate) + */ readonly playbackRate: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/start) */ + /** + * The `start()` method of the AudioBufferSourceNode Interface is used to schedule playback of the audio data contained in the buffer, or to begin playback immediately. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/start) + */ start(when?: number, offset?: number, duration?: number): void; addEventListener(type: K, listener: (this: AudioBufferSourceNode, ev: AudioScheduledSourceNodeEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3013,23 +3262,59 @@ declare var AudioBufferSourceNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext) */ interface AudioContext extends BaseAudioContext { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/baseLatency) */ + /** + * The **`baseLatency`** read-only property of the seconds of processing latency incurred by the `AudioContext` passing an audio buffer from the AudioDestinationNode โ€” i.e., the end of the audio graph โ€” into the host system's audio subsystem ready for playing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/baseLatency) + */ readonly baseLatency: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/outputLatency) */ + /** + * The **`outputLatency`** read-only property of the AudioContext Interface provides an estimation of the output latency of the current audio context. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/outputLatency) + */ readonly outputLatency: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/close) */ + /** + * The `close()` method of the AudioContext Interface closes the audio context, releasing any system audio resources that it uses. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/close) + */ close(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/createMediaElementSource) */ + /** + * The `createMediaElementSource()` method of the AudioContext Interface is used to create a new MediaElementAudioSourceNode object, given an existing HTML audio or video element, the audio from which can then be played and manipulated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/createMediaElementSource) + */ createMediaElementSource(mediaElement: HTMLMediaElement): MediaElementAudioSourceNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/createMediaStreamDestination) */ + /** + * The `createMediaStreamDestination()` method of the AudioContext Interface is used to create a new MediaStreamAudioDestinationNode object associated with a WebRTC MediaStream representing an audio stream, which may be stored in a local file or sent to another computer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/createMediaStreamDestination) + */ createMediaStreamDestination(): MediaStreamAudioDestinationNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/createMediaStreamSource) */ + /** + * The `createMediaStreamSource()` method of the AudioContext Interface is used to create a new MediaStreamAudioSourceNode object, given a media stream (say, from a MediaDevices.getUserMedia instance), the audio from which can then be played and manipulated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/createMediaStreamSource) + */ createMediaStreamSource(mediaStream: MediaStream): MediaStreamAudioSourceNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/getOutputTimestamp) */ + /** + * The **`getOutputTimestamp()`** method of the containing two audio timestamp values relating to the current audio context. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/getOutputTimestamp) + */ getOutputTimestamp(): AudioTimestamp; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/resume) */ + /** + * The **`resume()`** method of the AudioContext interface resumes the progression of time in an audio context that has previously been suspended. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/resume) + */ resume(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/suspend) */ + /** + * The `suspend()` method of the AudioContext Interface suspends the progression of time in the audio context, temporarily halting audio hardware access and reducing CPU/battery usage in the process โ€” this is useful if you want an application to power down the audio hardware when it will not be using an audio context for a while. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioContext/suspend) + */ suspend(): Promise; addEventListener(type: K, listener: (this: AudioContext, ev: BaseAudioContextEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3048,25 +3333,65 @@ declare var AudioContext: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData) */ interface AudioData { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/duration) */ + /** + * The **`duration`** read-only property of the AudioData interface returns the duration in microseconds of this `AudioData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/duration) + */ readonly duration: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/format) */ + /** + * The **`format`** read-only property of the AudioData interface returns the sample format of the `AudioData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/format) + */ readonly format: AudioSampleFormat | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/numberOfChannels) */ + /** + * The **`numberOfChannels`** read-only property of the AudioData interface returns the number of channels in the `AudioData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/numberOfChannels) + */ readonly numberOfChannels: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/numberOfFrames) */ + /** + * The **`numberOfFrames`** read-only property of the AudioData interface returns the number of frames in the `AudioData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/numberOfFrames) + */ readonly numberOfFrames: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/sampleRate) */ + /** + * The **`sampleRate`** read-only property of the AudioData interface returns the sample rate in Hz. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/sampleRate) + */ readonly sampleRate: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/timestamp) */ + /** + * The **`timestamp`** read-only property of the AudioData interface returns the timestamp of this `AudioData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/timestamp) + */ readonly timestamp: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/allocationSize) */ + /** + * The **`allocationSize()`** method of the AudioData interface returns the size in bytes required to hold the current sample as filtered by options passed into the method. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/allocationSize) + */ allocationSize(options: AudioDataCopyToOptions): number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/clone) */ + /** + * The **`clone()`** method of the AudioData interface creates a new `AudioData` object with reference to the same media resource as the original. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/clone) + */ clone(): AudioData; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/close) */ + /** + * The **`close()`** method of the AudioData interface clears all states and releases the reference to the media resource. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/close) + */ close(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/copyTo) */ + /** + * The **`copyTo()`** method of the AudioData interface copies a plane of an `AudioData` object to a destination buffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioData/copyTo) + */ copyTo(destination: AllowSharedBufferSource, options: AudioDataCopyToOptions): void; } @@ -3086,21 +3411,49 @@ interface AudioDecoderEventMap { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder) */ interface AudioDecoder extends EventTarget { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/decodeQueueSize) */ + /** + * The **`decodeQueueSize`** read-only property of the AudioDecoder interface returns the number of pending decode requests in the queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/decodeQueueSize) + */ readonly decodeQueueSize: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/dequeue_event) */ ondequeue: ((this: AudioDecoder, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/state) */ + /** + * The **`state`** read-only property of the AudioDecoder interface returns the current state of the underlying codec. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/state) + */ readonly state: CodecState; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/close) */ + /** + * The **`close()`** method of the AudioDecoder interface ends all pending work and releases system resources. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/close) + */ close(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/configure) */ + /** + * The **`configure()`** method of the AudioDecoder interface enqueues a control message to configure the audio decoder for decoding chunks. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/configure) + */ configure(config: AudioDecoderConfig): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/decode) */ - decode(chunk: EncodedAudioChunk): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/flush) */ + /** + * The **`decode()`** method of the AudioDecoder interface enqueues a control message to decode a given chunk of audio. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/decode) + */ + decode(chunk: EncodedAudioChunk): void; + /** + * The **`flush()`** method of the AudioDecoder interface returns a Promise that resolves once all pending messages in the queue have been completed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/flush) + */ flush(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/reset) */ + /** + * The **`reset()`** method of the AudioDecoder interface resets all states including configuration, control messages in the control message queue, and all pending callbacks. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDecoder/reset) + */ reset(): void; addEventListener(type: K, listener: (this: AudioDecoder, ev: AudioDecoderEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3121,7 +3474,11 @@ declare var AudioDecoder: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDestinationNode) */ interface AudioDestinationNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDestinationNode/maxChannelCount) */ + /** + * The `maxChannelCount` property of the AudioDestinationNode interface is an `unsigned long` defining the maximum amount of channels that the physical device can handle. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioDestinationNode/maxChannelCount) + */ readonly maxChannelCount: number; } @@ -3141,21 +3498,49 @@ interface AudioEncoderEventMap { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder) */ interface AudioEncoder extends EventTarget { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/encodeQueueSize) */ + /** + * The **`encodeQueueSize`** read-only property of the AudioEncoder interface returns the number of pending encode requests in the queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/encodeQueueSize) + */ readonly encodeQueueSize: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/dequeue_event) */ ondequeue: ((this: AudioEncoder, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/state) */ + /** + * The **`state`** read-only property of the AudioEncoder interface returns the current state of the underlying codec. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/state) + */ readonly state: CodecState; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/close) */ + /** + * The **`close()`** method of the AudioEncoder interface ends all pending work and releases system resources. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/close) + */ close(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/configure) */ + /** + * The **`configure()`** method of the AudioEncoder interface enqueues a control message to configure the audio encoder for encoding chunks. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/configure) + */ configure(config: AudioEncoderConfig): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/encode) */ + /** + * The **`encode()`** method of the AudioEncoder interface enqueues a control message to encode a given AudioData object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/encode) + */ encode(data: AudioData): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/flush) */ + /** + * The **`flush()`** method of the AudioEncoder interface returns a Promise that resolves once all pending messages in the queue have been completed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/flush) + */ flush(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/reset) */ + /** + * The **`reset()`** method of the AudioEncoder interface resets all states including configuration, control messages in the control message queue, and all pending callbacks. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioEncoder/reset) + */ reset(): void; addEventListener(type: K, listener: (this: AudioEncoder, ev: AudioEncoderEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3176,31 +3561,69 @@ declare var AudioEncoder: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener) */ interface AudioListener { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/forwardX) */ + /** + * The `forwardX` read-only property of the AudioListener interface is an AudioParam representing the x value of the direction vector defining the forward direction the listener is pointing in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/forwardX) + */ readonly forwardX: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/forwardY) */ + /** + * The `forwardY` read-only property of the AudioListener interface is an AudioParam representing the y value of the direction vector defining the forward direction the listener is pointing in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/forwardY) + */ readonly forwardY: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/forwardZ) */ + /** + * The `forwardZ` read-only property of the AudioListener interface is an AudioParam representing the z value of the direction vector defining the forward direction the listener is pointing in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/forwardZ) + */ readonly forwardZ: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/positionX) */ + /** + * The `positionX` read-only property of the AudioListener interface is an AudioParam representing the x position of the listener in 3D cartesian space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/positionX) + */ readonly positionX: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/positionY) */ + /** + * The `positionY` read-only property of the AudioListener interface is an AudioParam representing the y position of the listener in 3D cartesian space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/positionY) + */ readonly positionY: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/positionZ) */ + /** + * The `positionZ` read-only property of the AudioListener interface is an AudioParam representing the z position of the listener in 3D cartesian space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/positionZ) + */ readonly positionZ: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/upX) */ + /** + * The `upX` read-only property of the AudioListener interface is an AudioParam representing the x value of the direction vector defining the up direction the listener is pointing in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/upX) + */ readonly upX: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/upY) */ + /** + * The `upY` read-only property of the AudioListener interface is an AudioParam representing the y value of the direction vector defining the up direction the listener is pointing in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/upY) + */ readonly upY: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/upZ) */ + /** + * The `upZ` read-only property of the AudioListener interface is an AudioParam representing the z value of the direction vector defining the up direction the listener is pointing in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/upZ) + */ readonly upZ: AudioParam; /** + * The `setOrientation()` method of the AudioListener interface defines the orientation of the listener. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/setOrientation) */ setOrientation(x: number, y: number, z: number, xUp: number, yUp: number, zUp: number): void; /** + * The `setPosition()` method of the AudioListener Interface defines the position of the listener. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioListener/setPosition) @@ -3219,22 +3642,54 @@ declare var AudioListener: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode) */ interface AudioNode extends EventTarget { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/channelCount) */ + /** + * The **`channelCount`** property of the AudioNode interface represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/channelCount) + */ channelCount: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/channelCountMode) */ + /** + * The `channelCountMode` property of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/channelCountMode) + */ channelCountMode: ChannelCountMode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/channelInterpretation) */ + /** + * The **`channelInterpretation`** property of the AudioNode interface represents an enumerated value describing how input channels are mapped to output channels when the number of inputs/outputs is different. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/channelInterpretation) + */ channelInterpretation: ChannelInterpretation; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/context) */ + /** + * The read-only `context` property of the the node is participating in. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/context) + */ readonly context: BaseAudioContext; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/numberOfInputs) */ + /** + * The `numberOfInputs` property of the AudioNode interface returns the number of inputs feeding the node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/numberOfInputs) + */ readonly numberOfInputs: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/numberOfOutputs) */ + /** + * The `numberOfOutputs` property of the AudioNode interface returns the number of outputs coming out of the node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/numberOfOutputs) + */ readonly numberOfOutputs: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/connect) */ + /** + * The `connect()` method of the AudioNode interface lets you connect one of the node's outputs to a target, which may be either another `AudioNode` (thereby directing the sound data to the specified node) or an change the value of that parameter over time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/connect) + */ connect(destinationNode: AudioNode, output?: number, input?: number): AudioNode; connect(destinationParam: AudioParam, output?: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/disconnect) */ + /** + * The **`disconnect()`** method of the AudioNode interface lets you disconnect one or more nodes from the node on which the method is called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/disconnect) + */ disconnect(): void; disconnect(output: number): void; disconnect(destinationNode: AudioNode): void; @@ -3256,27 +3711,71 @@ declare var AudioNode: { */ interface AudioParam { automationRate: AutomationRate; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/defaultValue) */ + /** + * The **`defaultValue`** read-only property of the AudioParam interface represents the initial value of the attributes as defined by the specific AudioNode creating the `AudioParam`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/defaultValue) + */ readonly defaultValue: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/maxValue) */ + /** + * The **`maxValue`** read-only property of the AudioParam interface represents the maximum possible value for the parameter's nominal (effective) range. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/maxValue) + */ readonly maxValue: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/minValue) */ + /** + * The **`minValue`** read-only property of the AudioParam interface represents the minimum possible value for the parameter's nominal (effective) range. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/minValue) + */ readonly minValue: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/value) */ + /** + * The **`value`** property of the AudioParam interface gets or sets the value of this `AudioParam` at the current time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/value) + */ value: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/cancelAndHoldAtTime) */ + /** + * The **`cancelAndHoldAtTime()`** method of the `AudioParam` but holds its value at a given time until further changes are made using other methods. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/cancelAndHoldAtTime) + */ cancelAndHoldAtTime(cancelTime: number): AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/cancelScheduledValues) */ + /** + * The `cancelScheduledValues()` method of the AudioParam Interface cancels all scheduled future changes to the `AudioParam`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/cancelScheduledValues) + */ cancelScheduledValues(cancelTime: number): AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/exponentialRampToValueAtTime) */ + /** + * The **`exponentialRampToValueAtTime()`** method of the AudioParam Interface schedules a gradual exponential change in the value of the AudioParam. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/exponentialRampToValueAtTime) + */ exponentialRampToValueAtTime(value: number, endTime: number): AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/linearRampToValueAtTime) */ + /** + * The `linearRampToValueAtTime()` method of the AudioParam Interface schedules a gradual linear change in the value of the `AudioParam`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/linearRampToValueAtTime) + */ linearRampToValueAtTime(value: number, endTime: number): AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setTargetAtTime) */ + /** + * The `setTargetAtTime()` method of the `AudioParam` value. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setTargetAtTime) + */ setTargetAtTime(target: number, startTime: number, timeConstant: number): AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setValueAtTime) */ + /** + * The `setValueAtTime()` method of the `AudioParam` value at a precise time, as measured against ```js-nolint setValueAtTime(value, startTime) ``` - `value` - : A floating point number representing the value the AudioParam will change to at the given time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setValueAtTime) + */ setValueAtTime(value: number, startTime: number): AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setValueCurveAtTime) */ + /** + * The **`setValueCurveAtTime()`** method of the following a curve defined by a list of values. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setValueCurveAtTime) + */ setValueCurveAtTime(values: number[] | Float32Array, startTime: number, duration: number): AudioParam; } @@ -3307,18 +3806,21 @@ declare var AudioParamMap: { */ interface AudioProcessingEvent extends Event { /** + * The **`inputBuffer`** read-only property of the AudioProcessingEvent interface represents the input buffer of an audio processing event. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioProcessingEvent/inputBuffer) */ readonly inputBuffer: AudioBuffer; /** + * The **`outputBuffer`** read-only property of the AudioProcessingEvent interface represents the output buffer of an audio processing event. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioProcessingEvent/outputBuffer) */ readonly outputBuffer: AudioBuffer; /** + * The **`playbackTime`** read-only property of the AudioProcessingEvent interface represents the time when the audio will be played. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioProcessingEvent/playbackTime) @@ -3344,9 +3846,17 @@ interface AudioScheduledSourceNodeEventMap { interface AudioScheduledSourceNode extends AudioNode { /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioScheduledSourceNode/ended_event) */ onended: ((this: AudioScheduledSourceNode, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioScheduledSourceNode/start) */ + /** + * The `start()` method on AudioScheduledSourceNode schedules a sound to begin playback at the specified time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioScheduledSourceNode/start) + */ start(when?: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioScheduledSourceNode/stop) */ + /** + * The `stop()` method on AudioScheduledSourceNode schedules a sound to cease playback at the specified time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioScheduledSourceNode/stop) + */ stop(when?: number): void; addEventListener(type: K, listener: (this: AudioScheduledSourceNode, ev: AudioScheduledSourceNodeEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3386,9 +3896,17 @@ interface AudioWorkletNodeEventMap { interface AudioWorkletNode extends AudioNode { /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletNode/processorerror_event) */ onprocessorerror: ((this: AudioWorkletNode, ev: ErrorEvent) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletNode/parameters) */ + /** + * The read-only **`parameters`** property of the underlying AudioWorkletProcessor according to its getter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletNode/parameters) + */ readonly parameters: AudioParamMap; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletNode/port) */ + /** + * The read-only **`port`** property of the associated AudioWorkletProcessor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletNode/port) + */ readonly port: MessagePort; addEventListener(type: K, listener: (this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3408,11 +3926,23 @@ declare var AudioWorkletNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse) */ interface AuthenticatorAssertionResponse extends AuthenticatorResponse { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse/authenticatorData) */ + /** + * The **`authenticatorData`** property of the AuthenticatorAssertionResponse interface returns an ArrayBuffer containing information from the authenticator such as the Relying Party ID Hash (rpIdHash), a signature counter, test of user presence, user verification flags, and any extensions processed by the authenticator. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse/authenticatorData) + */ readonly authenticatorData: ArrayBuffer; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse/signature) */ + /** + * The **`signature`** read-only property of the object which is the signature of the authenticator for both the client data (AuthenticatorResponse.clientDataJSON). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse/signature) + */ readonly signature: ArrayBuffer; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse/userHandle) */ + /** + * The **`userHandle`** read-only property of the AuthenticatorAssertionResponse interface is an ArrayBuffer object providing an opaque identifier for the given user. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAssertionResponse/userHandle) + */ readonly userHandle: ArrayBuffer | null; } @@ -3428,15 +3958,35 @@ declare var AuthenticatorAssertionResponse: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse) */ interface AuthenticatorAttestationResponse extends AuthenticatorResponse { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/attestationObject) */ + /** + * The **`attestationObject`** property of the entire `attestationObject` with a private key that is stored in the authenticator when it is manufactured. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/attestationObject) + */ readonly attestationObject: ArrayBuffer; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getAuthenticatorData) */ + /** + * The **`getAuthenticatorData()`** method of the AuthenticatorAttestationResponse interface returns an ArrayBuffer containing the authenticator data contained within the AuthenticatorAttestationResponse.attestationObject property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getAuthenticatorData) + */ getAuthenticatorData(): ArrayBuffer; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getPublicKey) */ + /** + * The **`getPublicKey()`** method of the AuthenticatorAttestationResponse interface returns an ArrayBuffer containing the DER `SubjectPublicKeyInfo` of the new credential (see Subject Public Key Info), or `null` if this is not available. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getPublicKey) + */ getPublicKey(): ArrayBuffer | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getPublicKeyAlgorithm) */ + /** + * The **`getPublicKeyAlgorithm()`** method of the AuthenticatorAttestationResponse interface returns a number that is equal to a COSE Algorithm Identifier, representing the cryptographic algorithm used for the new credential. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getPublicKeyAlgorithm) + */ getPublicKeyAlgorithm(): COSEAlgorithmIdentifier; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getTransports) */ + /** + * The **`getTransports()`** method of the AuthenticatorAttestationResponse interface returns an array of strings describing the different transports which may be used by the authenticator. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorAttestationResponse/getTransports) + */ getTransports(): string[]; } @@ -3452,7 +4002,11 @@ declare var AuthenticatorAttestationResponse: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorResponse) */ interface AuthenticatorResponse { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorResponse/clientDataJSON) */ + /** + * The **`clientDataJSON`** property of the AuthenticatorResponse interface stores a JSON string in an An ArrayBuffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AuthenticatorResponse/clientDataJSON) + */ readonly clientDataJSON: ArrayBuffer; } @@ -3467,7 +4021,11 @@ declare var AuthenticatorResponse: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BarProp) */ interface BarProp { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BarProp/visible) */ + /** + * The **`visible`** read-only property of the BarProp interface returns `true` if the user interface element it represents is visible. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BarProp/visible) + */ readonly visible: boolean; } @@ -3487,64 +4045,158 @@ interface BaseAudioContextEventMap { */ interface BaseAudioContext extends EventTarget { /** + * The `audioWorklet` read-only property of the processing. * Available only in secure contexts. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/audioWorklet) */ readonly audioWorklet: AudioWorklet; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/currentTime) */ + /** + * The `currentTime` read-only property of the BaseAudioContext interface returns a double representing an ever-increasing hardware timestamp in seconds that can be used for scheduling audio playback, visualizing timelines, etc. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/currentTime) + */ readonly currentTime: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/destination) */ + /** + * The `destination` property of the BaseAudioContext interface returns an AudioDestinationNode representing the final destination of all audio in the context. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/destination) + */ readonly destination: AudioDestinationNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/listener) */ + /** + * The `listener` property of the BaseAudioContext interface returns an AudioListener object that can then be used for implementing 3D audio spatialization. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/listener) + */ readonly listener: AudioListener; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/statechange_event) */ onstatechange: ((this: BaseAudioContext, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/sampleRate) */ + /** + * The `sampleRate` property of the BaseAudioContext interface returns a floating point number representing the sample rate, in samples per second, used by all nodes in this audio context. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/sampleRate) + */ readonly sampleRate: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/state) */ + /** + * The `state` read-only property of the BaseAudioContext interface returns the current state of the `AudioContext`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/state) + */ readonly state: AudioContextState; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createAnalyser) */ + /** + * The `createAnalyser()` method of the can be used to expose audio time and frequency data and create data visualizations. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createAnalyser) + */ createAnalyser(): AnalyserNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createBiquadFilter) */ + /** + * The `createBiquadFilter()` method of the BaseAudioContext interface creates a BiquadFilterNode, which represents a second order filter configurable as several different common filter types. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createBiquadFilter) + */ createBiquadFilter(): BiquadFilterNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createBuffer) */ + /** + * The `createBuffer()` method of the BaseAudioContext Interface is used to create a new, empty AudioBuffer object, which can then be populated by data, and played via an AudioBufferSourceNode. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createBuffer) + */ createBuffer(numberOfChannels: number, length: number, sampleRate: number): AudioBuffer; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createBufferSource) */ + /** + * The `createBufferSource()` method of the BaseAudioContext Interface is used to create a new AudioBufferSourceNode, which can be used to play audio data contained within an AudioBuffer object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createBufferSource) + */ createBufferSource(): AudioBufferSourceNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createChannelMerger) */ + /** + * The `createChannelMerger()` method of the BaseAudioContext interface creates a ChannelMergerNode, which combines channels from multiple audio streams into a single audio stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createChannelMerger) + */ createChannelMerger(numberOfInputs?: number): ChannelMergerNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createChannelSplitter) */ + /** + * The `createChannelSplitter()` method of the BaseAudioContext Interface is used to create a ChannelSplitterNode, which is used to access the individual channels of an audio stream and process them separately. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createChannelSplitter) + */ createChannelSplitter(numberOfOutputs?: number): ChannelSplitterNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createConstantSource) */ + /** + * The **`createConstantSource()`** property of the BaseAudioContext interface creates a outputs a monaural (one-channel) sound signal whose samples all have the same value. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createConstantSource) + */ createConstantSource(): ConstantSourceNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createConvolver) */ + /** + * The `createConvolver()` method of the BaseAudioContext interface creates a ConvolverNode, which is commonly used to apply reverb effects to your audio. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createConvolver) + */ createConvolver(): ConvolverNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createDelay) */ + /** + * The `createDelay()` method of the which is used to delay the incoming audio signal by a certain amount of time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createDelay) + */ createDelay(maxDelayTime?: number): DelayNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createDynamicsCompressor) */ + /** + * The `createDynamicsCompressor()` method of the BaseAudioContext Interface is used to create a DynamicsCompressorNode, which can be used to apply compression to an audio signal. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createDynamicsCompressor) + */ createDynamicsCompressor(): DynamicsCompressorNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createGain) */ + /** + * The `createGain()` method of the BaseAudioContext interface creates a GainNode, which can be used to control the overall gain (or volume) of the audio graph. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createGain) + */ createGain(): GainNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createIIRFilter) */ + /** + * The **`createIIRFilter()`** method of the BaseAudioContext interface creates an IIRFilterNode, which represents a general **infinite impulse response** (IIR) filter which can be configured to serve as various types of filter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createIIRFilter) + */ createIIRFilter(feedforward: number[], feedback: number[]): IIRFilterNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createOscillator) */ + /** + * The `createOscillator()` method of the BaseAudioContext interface creates an OscillatorNode, a source representing a periodic waveform. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createOscillator) + */ createOscillator(): OscillatorNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createPanner) */ + /** + * The `createPanner()` method of the BaseAudioContext Interface is used to create a new PannerNode, which is used to spatialize an incoming audio stream in 3D space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createPanner) + */ createPanner(): PannerNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createPeriodicWave) */ + /** + * The `createPeriodicWave()` method of the BaseAudioContext interface is used to create a PeriodicWave. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createPeriodicWave) + */ createPeriodicWave(real: number[] | Float32Array, imag: number[] | Float32Array, constraints?: PeriodicWaveConstraints): PeriodicWave; /** + * The `createScriptProcessor()` method of the BaseAudioContext interface creates a ScriptProcessorNode used for direct audio processing. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createScriptProcessor) */ createScriptProcessor(bufferSize?: number, numberOfInputChannels?: number, numberOfOutputChannels?: number): ScriptProcessorNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createStereoPanner) */ + /** + * The `createStereoPanner()` method of the BaseAudioContext interface creates a StereoPannerNode, which can be used to apply stereo panning to an audio source. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createStereoPanner) + */ createStereoPanner(): StereoPannerNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createWaveShaper) */ + /** + * The `createWaveShaper()` method of the BaseAudioContext interface creates a WaveShaperNode, which represents a non-linear distortion. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createWaveShaper) + */ createWaveShaper(): WaveShaperNode; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/decodeAudioData) */ + /** + * The `decodeAudioData()` method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an rate, then passed to a callback or promise. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/decodeAudioData) + */ decodeAudioData(audioData: ArrayBuffer, successCallback?: DecodeSuccessCallback | null, errorCallback?: DecodeErrorCallback | null): Promise; addEventListener(type: K, listener: (this: BaseAudioContext, ev: BaseAudioContextEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3564,6 +4216,7 @@ declare var BaseAudioContext: { */ interface BeforeUnloadEvent extends Event { /** + * The **`returnValue`** property of the `returnValue` is initialized to an empty string (`''`) value. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BeforeUnloadEvent/returnValue) @@ -3582,17 +4235,41 @@ declare var BeforeUnloadEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode) */ interface BiquadFilterNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/Q) */ + /** + * The `Q` property of the BiquadFilterNode interface is an a-rate AudioParam, a double representing a Q factor, or _quality factor_. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/Q) + */ readonly Q: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/detune) */ + /** + * The `detune` property of the BiquadFilterNode interface is an a-rate AudioParam representing detuning of the frequency in cents. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/detune) + */ readonly detune: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/frequency) */ + /** + * The `frequency` property of the BiquadFilterNode interface is an a-rate AudioParam โ€” a double representing a frequency in the current filtering algorithm measured in hertz (Hz). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/frequency) + */ readonly frequency: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/gain) */ + /** + * The `gain` property of the BiquadFilterNode interface is an a-rate AudioParam โ€” a double representing the gain used in the current filtering algorithm. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/gain) + */ readonly gain: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/type) */ + /** + * The `type` property of the BiquadFilterNode interface is a string (enum) value defining the kind of filtering algorithm the node is implementing. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/type) + */ type: BiquadFilterType; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/getFrequencyResponse) */ + /** + * The `getFrequencyResponse()` method of the BiquadFilterNode interface takes the current filtering algorithm's settings and calculates the frequency response for frequencies specified in a specified array of frequencies. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BiquadFilterNode/getFrequencyResponse) + */ getFrequencyResponse(frequencyHz: Float32Array, magResponse: Float32Array, phaseResponse: Float32Array): void; } @@ -3607,19 +4284,47 @@ declare var BiquadFilterNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob) */ interface Blob { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */ + /** + * The **`size`** read-only property of the Blob interface returns the size of the Blob or File in bytes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) + */ readonly size: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */ + /** + * The **`type`** read-only property of the Blob interface returns the MIME type of the file. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) + */ readonly type: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) */ + /** + * The **`arrayBuffer()`** method of the Blob interface returns a Promise that resolves with the contents of the blob as binary data contained in an ArrayBuffer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) + */ arrayBuffer(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/bytes) */ + /** + * The **`bytes()`** method of the Blob interface returns a Promise that resolves with a Uint8Array containing the contents of the blob as an array of bytes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/bytes) + */ bytes(): Promise>; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */ + /** + * The **`slice()`** method of the Blob interface creates and returns a new `Blob` object which contains data from a subset of the blob on which it's called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) + */ slice(start?: number, end?: number, contentType?: string): Blob; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) */ + /** + * The **`stream()`** method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the `Blob`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) + */ stream(): ReadableStream>; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */ + /** + * The **`text()`** method of the string containing the contents of the blob, interpreted as UTF-8. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) + */ text(): Promise; } @@ -3634,9 +4339,17 @@ declare var Blob: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BlobEvent) */ interface BlobEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BlobEvent/data) */ + /** + * The **`data`** read-only property of the BlobEvent interface represents a Blob associated with the event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BlobEvent/data) + */ readonly data: Blob; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BlobEvent/timecode) */ + /** + * The **`timecode`** read-only property of the BlobEvent interface indicates the difference between the timestamp of the first chunk of data, and the timestamp of the first chunk in the first `BlobEvent` produced by this recorder. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BlobEvent/timecode) + */ readonly timecode: DOMHighResTimeStamp; } @@ -3676,7 +4389,7 @@ interface BroadcastChannelEventMap { */ interface BroadcastChannel extends EventTarget { /** - * Returns the channel name (as passed to the constructor). + * The **`name`** read-only property of the BroadcastChannel interface returns a string, which uniquely identifies the given channel with its name. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BroadcastChannel/name) */ @@ -3686,13 +4399,13 @@ interface BroadcastChannel extends EventTarget { /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BroadcastChannel/messageerror_event) */ onmessageerror: ((this: BroadcastChannel, ev: MessageEvent) => any) | null; /** - * Closes the BroadcastChannel object, opening it up to garbage collection. + * The **`close()`** method of the BroadcastChannel interface terminates the connection to the underlying channel, allowing the object to be garbage collected. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BroadcastChannel/close) */ close(): void; /** - * Sends the given message to other BroadcastChannel objects set up for this channel. Messages can be structured objects, e.g. nested objects and arrays. + * The **`postMessage()`** method of the BroadcastChannel interface sends a message, which can be of any kind of Object, to each listener in any browsing context with the same origin. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BroadcastChannel/postMessage) */ @@ -3714,9 +4427,17 @@ declare var BroadcastChannel: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy) */ interface ByteLengthQueuingStrategy extends QueuingStrategy { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/highWaterMark) */ + /** + * The read-only **`ByteLengthQueuingStrategy.highWaterMark`** property returns the total number of bytes that can be contained in the internal queue before backpressure is applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/highWaterMark) + */ readonly highWaterMark: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/size) */ + /** + * The **`size()`** method of the `byteLength` property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/size) + */ readonly size: QueuingStrategySize; } @@ -3744,29 +4465,77 @@ declare var CDATASection: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody) */ interface CSPViolationReportBody extends ReportBody { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/blockedURL) */ + /** + * The **`blockedURL`** read-only property of the CSPViolationReportBody interface is a string value that represents the resource that was blocked because it violates a Content Security Policy (CSP). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/blockedURL) + */ readonly blockedURL: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/columnNumber) */ + /** + * The **`columnNumber`** read-only property of the CSPViolationReportBody interface indicates the column number in the source file that triggered the Content Security Policy (CSP) violation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/columnNumber) + */ readonly columnNumber: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/disposition) */ + /** + * The **`disposition`** read-only property of the CSPViolationReportBody interface indicates whether the user agent is configured to enforce Content Security Policy (CSP) violations or only report them. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/disposition) + */ readonly disposition: SecurityPolicyViolationEventDisposition; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/documentURL) */ + /** + * The **`documentURL`** read-only property of the CSPViolationReportBody interface is a string that represents the URL of the document or worker that violated the Content Security Policy (CSP). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/documentURL) + */ readonly documentURL: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/effectiveDirective) */ + /** + * The **`effectiveDirective`** read-only property of the CSPViolationReportBody interface is a string that represents the effective Content Security Policy (CSP) directive that was violated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/effectiveDirective) + */ readonly effectiveDirective: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/lineNumber) */ + /** + * The **`lineNumber`** read-only property of the CSPViolationReportBody interface indicates the line number in the source file that triggered the Content Security Policy (CSP) violation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/lineNumber) + */ readonly lineNumber: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/originalPolicy) */ + /** + * The **`originalPolicy`** read-only property of the CSPViolationReportBody interface is a string that represents the Content Security Policy (CSP) whose enforcement uncovered the violation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/originalPolicy) + */ readonly originalPolicy: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/referrer) */ + /** + * The **`referrer`** read-only property of the CSPViolationReportBody interface is a string that represents the URL of the referring page of the resource who's Content Security Policy (CSP) was violated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/referrer) + */ readonly referrer: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/sample) */ + /** + * The **`sample`** read-only property of the CSPViolationReportBody interface is a string that contains a part of the resource that violated the Content Security Policy (CSP). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/sample) + */ readonly sample: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/sourceFile) */ + /** + * The **`sourceFile`** read-only property of the CSPViolationReportBody interface indicates the URL of the source file that violated the Content Security Policy (CSP). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/sourceFile) + */ readonly sourceFile: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/statusCode) */ + /** + * The **`statusCode`** read-only property of the CSPViolationReportBody interface is a number representing the HTTP status code of the response to the request that triggered a Content Security Policy (CSP) violation (when loading a window or worker). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/statusCode) + */ readonly statusCode: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/toJSON) */ + /** + * The **`toJSON()`** method of the CSPViolationReportBody interface is a _serializer_, which returns a JSON representation of the `CSPViolationReportBody` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/toJSON) + */ toJSON(): any; } @@ -3781,7 +4550,11 @@ declare var CSPViolationReportBody: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSAnimation) */ interface CSSAnimation extends Animation { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSAnimation/animationName) */ + /** + * The **`animationName`** property of the specifies one or more keyframe at-rules which describe the animation applied to the element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSAnimation/animationName) + */ readonly animationName: string; addEventListener(type: K, listener: (this: CSSAnimation, ev: AnimationEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -3800,7 +4573,11 @@ declare var CSSAnimation: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSConditionRule) */ interface CSSConditionRule extends CSSGroupingRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSConditionRule/conditionText) */ + /** + * The read-only **`conditionText`** property of the CSSConditionRule interface returns or sets the text of the CSS rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSConditionRule/conditionText) + */ readonly conditionText: string; } @@ -3815,9 +4592,17 @@ declare var CSSConditionRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSContainerRule) */ interface CSSContainerRule extends CSSConditionRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSContainerRule/containerName) */ + /** + * The read-only **`containerName`** property of the CSSContainerRule interface represents the container name of the associated CSS @container at-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSContainerRule/containerName) + */ readonly containerName: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSContainerRule/containerQuery) */ + /** + * The read-only **`containerQuery`** property of the CSSContainerRule interface returns a string representing the container conditions that are evaluated when the container changes size in order to determine if the styles in the associated @container are applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSContainerRule/containerQuery) + */ readonly containerQuery: string; } @@ -3832,27 +4617,71 @@ declare var CSSContainerRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule) */ interface CSSCounterStyleRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/additiveSymbols) */ + /** + * The **`additiveSymbols`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/additive-symbols descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/additiveSymbols) + */ additiveSymbols: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/fallback) */ + /** + * The **`fallback`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/fallback descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/fallback) + */ fallback: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/name) */ + /** + * The **`name`** property of the CSSCounterStyleRule interface gets and sets the <custom-ident> defined as the `name` for the associated rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/name) + */ name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/negative) */ + /** + * The **`negative`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/negative descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/negative) + */ negative: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/pad) */ + /** + * The **`pad`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/pad descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/pad) + */ pad: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/prefix) */ + /** + * The **`prefix`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/prefix descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/prefix) + */ prefix: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/range) */ + /** + * The **`range`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/range descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/range) + */ range: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/speakAs) */ + /** + * The **`speakAs`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/speak-as descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/speakAs) + */ speakAs: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/suffix) */ + /** + * The **`suffix`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/suffix descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/suffix) + */ suffix: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/symbols) */ + /** + * The **`symbols`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/symbols descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/symbols) + */ symbols: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/system) */ + /** + * The **`system`** property of the CSSCounterStyleRule interface gets and sets the value of the @counter-style/system descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSCounterStyleRule/system) + */ system: string; } @@ -3867,7 +4696,11 @@ declare var CSSCounterStyleRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFaceRule) */ interface CSSFontFaceRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFaceRule/style) */ + /** + * The read-only **`style`** property of the CSSFontFaceRule interface returns the style information from the @font-face at-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFaceRule/style) + */ get style(): CSSStyleDeclaration; set style(cssText: string); } @@ -3883,7 +4716,11 @@ declare var CSSFontFaceRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFeatureValuesRule) */ interface CSSFontFeatureValuesRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFeatureValuesRule/fontFamily) */ + /** + * The **`fontFamily`** property of the CSSConditionRule interface represents the name of the font family it applies to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFeatureValuesRule/fontFamily) + */ fontFamily: string; } @@ -3898,13 +4735,29 @@ declare var CSSFontFeatureValuesRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule) */ interface CSSFontPaletteValuesRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/basePalette) */ + /** + * The read-only **`basePalette`** property of the CSSFontPaletteValuesRule interface indicates the base palette associated with the rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/basePalette) + */ readonly basePalette: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/fontFamily) */ + /** + * The read-only **`fontFamily`** property of the CSSFontPaletteValuesRule interface lists the font families the rule can be applied to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/fontFamily) + */ readonly fontFamily: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/name) */ + /** + * The read-only **`name`** property of the CSSFontPaletteValuesRule interface represents the name identifying the associated @font-palette-values at-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/overrideColors) */ + /** + * The read-only **`overrideColors`** property of the CSSFontPaletteValuesRule interface is a string containing a list of color index and color pair that are to be used instead. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontPaletteValuesRule/overrideColors) + */ readonly overrideColors: string; } @@ -3919,11 +4772,23 @@ declare var CSSFontPaletteValuesRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule) */ interface CSSGroupingRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule/cssRules) */ + /** + * The **`cssRules`** property of the a collection of CSSRule objects. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule/cssRules) + */ readonly cssRules: CSSRuleList; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule/deleteRule) */ + /** + * The **`deleteRule()`** method of the rules. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule/deleteRule) + */ deleteRule(index: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule/insertRule) */ + /** + * The **`insertRule()`** method of the ```js-nolint insertRule(rule) insertRule(rule, index) ``` - `rule` - : A string - `index` [MISSING: optional_inline] - : An optional index at which to insert the rule; defaults to 0. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSGroupingRule/insertRule) + */ insertRule(rule: string, index?: number): number; } @@ -3951,16 +4816,36 @@ declare var CSSImageValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule) */ interface CSSImportRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/href) */ + /** + * The read-only **`href`** property of the The resolved URL will be the `href` attribute of the associated stylesheet. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/href) + */ readonly href: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/layerName) */ + /** + * The read-only **`layerName`** property of the CSSImportRule interface returns the name of the cascade layer created by the @import at-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/layerName) + */ readonly layerName: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/media) */ + /** + * The read-only **`media`** property of the containing the value of the `media` attribute of the associated stylesheet. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/media) + */ get media(): MediaList; set media(mediaText: string); - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/styleSheet) */ + /** + * The read-only **`styleSheet`** property of the in the form of a CSSStyleSheet object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/styleSheet) + */ readonly styleSheet: CSSStyleSheet | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/supportsText) */ + /** + * The read-only **`supportsText`** property of the CSSImportRule interface returns the supports condition specified by the @import at-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/supportsText) + */ readonly supportsText: string | null; } @@ -3975,9 +4860,17 @@ declare var CSSImportRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframeRule) */ interface CSSKeyframeRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframeRule/keyText) */ + /** + * The **`keyText`** property of the CSSKeyframeRule interface represents the keyframe selector as a comma-separated list of percentage values. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframeRule/keyText) + */ keyText: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframeRule/style) */ + /** + * The read-only **`CSSKeyframeRule.style`** property is the CSSStyleDeclaration interface for the declaration block of the CSSKeyframeRule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframeRule/style) + */ get style(): CSSStyleDeclaration; set style(cssText: string); } @@ -3993,17 +4886,41 @@ declare var CSSKeyframeRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule) */ interface CSSKeyframesRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/cssRules) */ + /** + * The read-only **`cssRules`** property of the CSSKeyframeRule interface returns a CSSRuleList containing the rules in the keyframes at-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/cssRules) + */ readonly cssRules: CSSRuleList; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/length) */ + /** + * The read-only **`length`** property of the CSSKeyframeRule interface returns the number of CSSKeyframeRule objects in its list. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/length) + */ readonly length: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/name) */ + /** + * The **`name`** property of the CSSKeyframeRule interface gets and sets the name of the animation as used by the animation-name property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/name) + */ name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/appendRule) */ + /** + * The **`appendRule()`** method of the CSSKeyframeRule interface appends a CSSKeyFrameRule to the end of the rules. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/appendRule) + */ appendRule(rule: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/deleteRule) */ + /** + * The **`deleteRule()`** method of the CSSKeyframeRule interface deletes the CSSKeyFrameRule that matches the specified keyframe selector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/deleteRule) + */ deleteRule(select: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/findRule) */ + /** + * The **`findRule()`** method of the CSSKeyframeRule interface finds the CSSKeyFrameRule that matches the specified keyframe selector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule/findRule) + */ findRule(select: string): CSSKeyframeRule | null; [index: number]: CSSKeyframeRule; } @@ -4019,7 +4936,11 @@ declare var CSSKeyframesRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeywordValue) */ interface CSSKeywordValue extends CSSStyleValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeywordValue/value) */ + /** + * The **`value`** property of the `CSSKeywordValue`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeywordValue/value) + */ value: string; } @@ -4034,7 +4955,11 @@ declare var CSSKeywordValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSLayerBlockRule) */ interface CSSLayerBlockRule extends CSSGroupingRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSLayerBlockRule/name) */ + /** + * The read-only **`name`** property of the CSSLayerBlockRule interface represents the name of the associated cascade layer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSLayerBlockRule/name) + */ readonly name: string; } @@ -4049,7 +4974,11 @@ declare var CSSLayerBlockRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSLayerStatementRule) */ interface CSSLayerStatementRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSLayerStatementRule/nameList) */ + /** + * The read-only **`nameList`** property of the CSSLayerStatementRule interface return the list of associated cascade layer names. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSLayerStatementRule/nameList) + */ readonly nameList: ReadonlyArray; } @@ -4075,7 +5004,11 @@ declare var CSSMathClamp: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathInvert) */ interface CSSMathInvert extends CSSMathValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathInvert/value) */ + /** + * The CSSMathInvert.value read-only property of the A CSSNumericValue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathInvert/value) + */ readonly value: CSSNumericValue; } @@ -4090,7 +5023,11 @@ declare var CSSMathInvert: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathMax) */ interface CSSMathMax extends CSSMathValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathMax/values) */ + /** + * The CSSMathMax.values read-only property of the which contains one or more CSSNumericValue objects. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathMax/values) + */ readonly values: CSSNumericArray; } @@ -4105,7 +5042,11 @@ declare var CSSMathMax: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathMin) */ interface CSSMathMin extends CSSMathValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathMin/values) */ + /** + * The CSSMathMin.values read-only property of the which contains one or more CSSNumericValue objects. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathMin/values) + */ readonly values: CSSNumericArray; } @@ -4120,7 +5061,11 @@ declare var CSSMathMin: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathNegate) */ interface CSSMathNegate extends CSSMathValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathNegate/value) */ + /** + * The CSSMathNegate.value read-only property of the A CSSNumericValue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathNegate/value) + */ readonly value: CSSNumericValue; } @@ -4135,7 +5080,11 @@ declare var CSSMathNegate: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathProduct) */ interface CSSMathProduct extends CSSMathValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathProduct/values) */ + /** + * The **`CSSMathProduct.values`** read-only property of the CSSMathProduct interface returns a A CSSNumericArray. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathProduct/values) + */ readonly values: CSSNumericArray; } @@ -4150,7 +5099,11 @@ declare var CSSMathProduct: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathSum) */ interface CSSMathSum extends CSSMathValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathSum/values) */ + /** + * The **`CSSMathSum.values`** read-only property of the CSSMathSum interface returns a CSSNumericArray object which contains one or more CSSNumericValue objects. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathSum/values) + */ readonly values: CSSNumericArray; } @@ -4165,7 +5118,11 @@ declare var CSSMathSum: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathValue) */ interface CSSMathValue extends CSSNumericValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathValue/operator) */ + /** + * The **`CSSMathValue.operator`** read-only property of the CSSMathValue interface indicates the operator that the current subtype represents. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathValue/operator) + */ readonly operator: CSSMathOperator; } @@ -4180,7 +5137,11 @@ declare var CSSMathValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMatrixComponent) */ interface CSSMatrixComponent extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMatrixComponent/matrix) */ + /** + * The **`matrix`** property of the See the matrix() and matrix3d() pages for examples. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMatrixComponent/matrix) + */ matrix: DOMMatrix; } @@ -4195,7 +5156,11 @@ declare var CSSMatrixComponent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMediaRule) */ interface CSSMediaRule extends CSSConditionRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMediaRule/media) */ + /** + * The read-only **`media`** property of the destination medium for style information. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMediaRule/media) + */ get media(): MediaList; set media(mediaText: string); } @@ -4211,9 +5176,17 @@ declare var CSSMediaRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNamespaceRule) */ interface CSSNamespaceRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNamespaceRule/namespaceURI) */ + /** + * The read-only **`namespaceURI`** property of the CSSNamespaceRule returns a string containing the text of the URI of the given namespace. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNamespaceRule/namespaceURI) + */ readonly namespaceURI: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNamespaceRule/prefix) */ + /** + * The read-only **`prefix`** property of the CSSNamespaceRule returns a string with the name of the prefix associated to this namespace. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNamespaceRule/prefix) + */ readonly prefix: string; } @@ -4228,7 +5201,11 @@ declare var CSSNamespaceRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNestedDeclarations) */ interface CSSNestedDeclarations extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNestedDeclarations/style) */ + /** + * The read-only **`style`** property of the CSSNestedDeclarations interface represents the styles associated with the nested rules. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNestedDeclarations/style) + */ get style(): CSSStyleDeclaration; set style(cssText: string); } @@ -4244,7 +5221,11 @@ declare var CSSNestedDeclarations: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericArray) */ interface CSSNumericArray { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericArray/length) */ + /** + * The read-only **`length`** property of the An integer representing the number of CSSNumericValue objects in the list. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericArray/length) + */ readonly length: number; forEach(callbackfn: (value: CSSNumericValue, key: number, parent: CSSNumericArray) => void, thisArg?: any): void; [index: number]: CSSNumericValue; @@ -4261,25 +5242,65 @@ declare var CSSNumericArray: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue) */ interface CSSNumericValue extends CSSStyleValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/add) */ + /** + * The **`add()`** method of the `CSSNumericValue`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/add) + */ add(...values: CSSNumberish[]): CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/div) */ + /** + * The **`div()`** method of the supplied value. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/div) + */ div(...values: CSSNumberish[]): CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/equals) */ + /** + * The **`equals()`** method of the value are strictly equal. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/equals) + */ equals(...value: CSSNumberish[]): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/max) */ + /** + * The **`max()`** method of the passed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/max) + */ max(...values: CSSNumberish[]): CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/min) */ + /** + * The **`min()`** method of the values passed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/min) + */ min(...values: CSSNumberish[]): CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/mul) */ + /** + * The **`mul()`** method of the the supplied value. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/mul) + */ mul(...values: CSSNumberish[]): CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/sub) */ + /** + * The **`sub()`** method of the `CSSNumericValue`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/sub) + */ sub(...values: CSSNumberish[]): CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/to) */ + /** + * The **`to()`** method of the another. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/to) + */ to(unit: string): CSSUnitValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/toSum) */ + /** + * The **`toSum()`** method of the ```js-nolint toSum(units) ``` - `units` - : The units to convert to. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/toSum) + */ toSum(...units: string[]): CSSMathSum; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/type) */ + /** + * The **`type()`** method of the `CSSNumericValue`, one of `angle`, `flex`, `frequency`, `length`, `resolution`, `percent`, `percentHint`, or `time`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSNumericValue/type) + */ type(): CSSNumericType; } @@ -4296,9 +5317,17 @@ declare var CSSNumericValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPageRule) */ interface CSSPageRule extends CSSGroupingRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPageRule/selectorText) */ + /** + * The **`selectorText`** property of the CSSPageRule interface gets and sets the selectors associated with the `CSSPageRule`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPageRule/selectorText) + */ selectorText: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPageRule/style) */ + /** + * The **`style`** read-only property of the CSSPageRule interface returns a CSSPageDescriptors object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPageRule/style) + */ get style(): CSSStyleDeclaration; set style(cssText: string); } @@ -4314,8 +5343,12 @@ declare var CSSPageRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPerspective) */ interface CSSPerspective extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPerspective/length) */ - length: CSSPerspectiveValue; + /** + * The **`length`** property of the It is used to apply a perspective transform to the element and its content. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPerspective/length) + */ + length: CSSPerspectiveValue; } declare var CSSPerspective: { @@ -4329,13 +5362,29 @@ declare var CSSPerspective: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule) */ interface CSSPropertyRule extends CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/inherits) */ + /** + * The read-only **`inherits`** property of the CSSPropertyRule interface returns the inherit flag of the custom property registration represented by the @property rule, a boolean describing whether or not the property inherits by default. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/inherits) + */ readonly inherits: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/initialValue) */ + /** + * The read-only **`initialValue`** nullable property of the CSSPropertyRule interface returns the initial value of the custom property registration represented by the @property rule, controlling the property's initial value. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/initialValue) + */ readonly initialValue: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/name) */ + /** + * The read-only **`name`** property of the CSSPropertyRule interface represents the property name, this being the serialization of the name given to the custom property in the @property rule's prelude. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/syntax) */ + /** + * The read-only **`syntax`** property of the CSSPropertyRule interface returns the literal syntax of the custom property registration represented by the @property rule, controlling how the property's value is parsed at computed-value time. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPropertyRule/syntax) + */ readonly syntax: string; } @@ -4350,13 +5399,29 @@ declare var CSSPropertyRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate) */ interface CSSRotate extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/angle) */ + /** + * The **`angle`** property of the denotes a clockwise rotation, a negative angle a counter-clockwise one. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/angle) + */ angle: CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/x) */ + /** + * The **`x`** property of the translating vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/x) + */ x: CSSNumberish; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/y) */ + /** + * The **`y`** property of the translating vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/y) + */ y: CSSNumberish; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/z) */ + /** + * The **`z`** property of the vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRotate/z) + */ z: CSSNumberish; } @@ -4372,13 +5437,26 @@ declare var CSSRotate: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule) */ interface CSSRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/cssText) */ + /** + * The **`cssText`** property of the CSSRule interface returns the actual text of a CSSStyleSheet style-rule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/cssText) + */ cssText: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/parentRule) */ + /** + * The **`parentRule`** property of the CSSRule interface returns the containing rule of the current rule if this exists, or otherwise returns null. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/parentRule) + */ readonly parentRule: CSSRule | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/parentStyleSheet) */ + /** + * The **`parentStyleSheet`** property of the the current rule is defined. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/parentStyleSheet) + */ readonly parentStyleSheet: CSSStyleSheet | null; /** + * The read-only **`type`** property of the indicating which type of rule the CSSRule represents. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRule/type) @@ -4421,9 +5499,17 @@ declare var CSSRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRuleList) */ interface CSSRuleList { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRuleList/length) */ + /** + * The **`length`** property of the CSSRuleList interface returns the number of CSSRule objects in the list. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRuleList/length) + */ readonly length: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRuleList/item) */ + /** + * The **`item()`** method of the CSSRuleList interface returns the CSSRule object at the specified `index` or `null` if the specified `index` doesn't exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSRuleList/item) + */ item(index: number): CSSRule | null; [index: number]: CSSRule; } @@ -4439,11 +5525,23 @@ declare var CSSRuleList: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale) */ interface CSSScale extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale/x) */ + /** + * The **`x`** property of the translating vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale/x) + */ x: CSSNumberish; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale/y) */ + /** + * The **`y`** property of the translating vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale/y) + */ y: CSSNumberish; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale/z) */ + /** + * The **`z`** property of the vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScale/z) + */ z: CSSNumberish; } @@ -4458,9 +5556,17 @@ declare var CSSScale: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScopeRule) */ interface CSSScopeRule extends CSSGroupingRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScopeRule/end) */ + /** + * The **`end`** property of the CSSScopeRule interface returns a string containing the value of the `@scope` at-rule's scope limit. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScopeRule/end) + */ readonly end: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScopeRule/start) */ + /** + * The **`start`** property of the CSSScopeRule interface returns a string containing the value of the `@scope` at-rule's scope root. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSScopeRule/start) + */ readonly start: string | null; } @@ -4475,9 +5581,17 @@ declare var CSSScopeRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkew) */ interface CSSSkew extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkew/ax) */ + /** + * The **`ax`** property of the along the x-axis (or abscissa). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkew/ax) + */ ax: CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkew/ay) */ + /** + * The **`ay`** property of the along the y-axis (or ordinate). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkew/ay) + */ ay: CSSNumericValue; } @@ -4492,7 +5606,11 @@ declare var CSSSkew: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkewX) */ interface CSSSkewX extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkewX/ax) */ + /** + * The **`ax`** property of the along the x-axis (or abscissa). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkewX/ax) + */ ax: CSSNumericValue; } @@ -4507,7 +5625,11 @@ declare var CSSSkewX: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkewY) */ interface CSSSkewY extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkewY/ay) */ + /** + * The **`ay`** property of the along the y-axis (or ordinate). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSSkewY/ay) + */ ay: CSSNumericValue; } @@ -4813,7 +5935,11 @@ interface CSSStyleDeclaration { counterSet: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/cssFloat) */ cssFloat: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/cssText) */ + /** + * The **`cssText`** property of the CSSStyleDeclaration interface returns or sets the text of the element's **inline** style declaration only. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/cssText) + */ cssText: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/cursor) */ cursor: string; @@ -4991,7 +6117,11 @@ interface CSSStyleDeclaration { justifySelf: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/left) */ left: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/length) */ + /** + * The read-only property returns an integer that represents the number of style declarations in this CSS declaration block. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/length) + */ readonly length: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/letter-spacing) */ letterSpacing: string; @@ -5183,7 +6313,11 @@ interface CSSStyleDeclaration { pageBreakInside: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/paint-order) */ paintOrder: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/parentRule) */ + /** + * The **CSSStyleDeclaration.parentRule** read-only property returns a CSSRule that is the parent of this style block, e.g., a CSSStyleRule representing the style for a CSS selector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/parentRule) + */ readonly parentRule: CSSRule | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/perspective) */ perspective: string; @@ -5838,15 +6972,35 @@ interface CSSStyleDeclaration { zIndex: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/zoom) */ zoom: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/getPropertyPriority) */ + /** + * The **CSSStyleDeclaration.getPropertyPriority()** method interface returns a string that provides all explicitly set priorities on the CSS property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/getPropertyPriority) + */ getPropertyPriority(property: string): string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/getPropertyValue) */ + /** + * The **CSSStyleDeclaration.getPropertyValue()** method interface returns a string containing the value of a specified CSS property. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/getPropertyValue) + */ getPropertyValue(property: string): string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/item) */ + /** + * The `CSSStyleDeclaration.item()` method interface returns a CSS property name from a CSSStyleDeclaration by index. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/item) + */ item(index: number): string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/removeProperty) */ + /** + * The **`CSSStyleDeclaration.removeProperty()`** method interface removes a property from a CSS style declaration object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/removeProperty) + */ removeProperty(property: string): string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/setProperty) */ + /** + * The **`CSSStyleDeclaration.setProperty()`** method interface sets a new value for a property on a CSS style declaration object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleDeclaration/setProperty) + */ setProperty(property: string, value: string | null, priority?: string): void; [index: number]: string; } @@ -5862,12 +7016,24 @@ declare var CSSStyleDeclaration: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule) */ interface CSSStyleRule extends CSSGroupingRule { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/selectorText) */ + /** + * The **`selectorText`** property of the CSSStyleRule interface gets and sets the selectors associated with the `CSSStyleRule`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/selectorText) + */ selectorText: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/style) */ + /** + * The read-only **`style`** property is the CSSStyleDeclaration interface for the declaration block of the CSSStyleRule. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/style) + */ get style(): CSSStyleDeclaration; set style(cssText: string); - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/styleMap) */ + /** + * The **`styleMap`** read-only property of the which provides access to the rule's property-value pairs. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/styleMap) + */ readonly styleMap: StylePropertyMap; } @@ -5882,35 +7048,62 @@ declare var CSSStyleRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet) */ interface CSSStyleSheet extends StyleSheet { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/cssRules) */ + /** + * The read-only CSSStyleSheet property **`cssRules`** returns a live CSSRuleList which provides a real-time, up-to-date list of every CSS rule which comprises the stylesheet. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/cssRules) + */ readonly cssRules: CSSRuleList; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/ownerRule) */ + /** + * The read-only CSSStyleSheet property **`ownerRule`** returns the CSSImportRule corresponding to the @import at-rule which imported the stylesheet into the document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/ownerRule) + */ readonly ownerRule: CSSRule | null; /** + * **`rules`** is a _deprecated_ _legacy property_ of the CSSStyleSheet interface. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/rules) */ readonly rules: CSSRuleList; /** + * The obsolete CSSStyleSheet interface's **`addRule()`** _legacy method_ adds a new rule to the stylesheet. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/addRule) */ addRule(selector?: string, style?: string, index?: number): number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/deleteRule) */ + /** + * The CSSStyleSheet method **`deleteRule()`** removes a rule from the stylesheet object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/deleteRule) + */ deleteRule(index: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/insertRule) */ + /** + * The **`CSSStyleSheet.insertRule()`** method inserts a new CSS rule into the current style sheet. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/insertRule) + */ insertRule(rule: string, index?: number): number; /** + * The obsolete CSSStyleSheet method **`removeRule()`** removes a rule from the stylesheet object. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/removeRule) */ removeRule(index?: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/replace) */ + /** + * The **`replace()`** method of the CSSStyleSheet interface asynchronously replaces the content of the stylesheet with the content passed into it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/replace) + */ replace(text: string): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/replaceSync) */ + /** + * The **`replaceSync()`** method of the CSSStyleSheet interface synchronously replaces the content of the stylesheet with the content passed into it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet/replaceSync) + */ replaceSync(text: string): void; } @@ -5956,9 +7149,17 @@ declare var CSSSupportsRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformComponent) */ interface CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformComponent/is2D) */ + /** + * The **`is2D`** read-only property of the CSSTransformComponent interface indicates where the transform is 2D or 3D. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformComponent/is2D) + */ is2D: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformComponent/toMatrix) */ + /** + * The **`toMatrix()`** method of the object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformComponent/toMatrix) + */ toMatrix(): DOMMatrix; toString(): string; } @@ -5974,11 +7175,23 @@ declare var CSSTransformComponent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue) */ interface CSSTransformValue extends CSSStyleValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue/is2D) */ + /** + * The read-only **`is2D`** property of the In the case of the `CSSTransformValue` this property returns true unless any of the individual functions return false for `Is2D`, in which case it returns false. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue/is2D) + */ readonly is2D: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue/length) */ + /** + * The read-only **`length`** property of the the list. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue/length) + */ readonly length: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue/toMatrix) */ + /** + * The **`toMatrix()`** method of the ```js-nolint toMatrix() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransformValue/toMatrix) + */ toMatrix(): DOMMatrix; forEach(callbackfn: (value: CSSTransformComponent, key: number, parent: CSSTransformValue) => void, thisArg?: any): void; [index: number]: CSSTransformComponent; @@ -5995,7 +7208,11 @@ declare var CSSTransformValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransition) */ interface CSSTransition extends Animation { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransition/transitionProperty) */ + /** + * The **`transitionProperty`** property of the name** of the transition. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTransition/transitionProperty) + */ readonly transitionProperty: string; addEventListener(type: K, listener: (this: CSSTransition, ev: AnimationEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -6014,11 +7231,23 @@ declare var CSSTransition: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate) */ interface CSSTranslate extends CSSTransformComponent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate/x) */ + /** + * The **`x`** property of the translating vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate/x) + */ x: CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate/y) */ + /** + * The **`y`** property of the translating vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate/y) + */ y: CSSNumericValue; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate/z) */ + /** + * The **`z`** property of the vector. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSTranslate/z) + */ z: CSSNumericValue; } @@ -6033,9 +7262,17 @@ declare var CSSTranslate: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnitValue) */ interface CSSUnitValue extends CSSNumericValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnitValue/unit) */ + /** + * The **`CSSUnitValue.unit`** read-only property of the CSSUnitValue interface returns a string indicating the type of unit. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnitValue/unit) + */ readonly unit: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnitValue/value) */ + /** + * The **`CSSUnitValue.value`** property of the A double. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnitValue/value) + */ value: number; } @@ -6050,7 +7287,11 @@ declare var CSSUnitValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnparsedValue) */ interface CSSUnparsedValue extends CSSStyleValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnparsedValue/length) */ + /** + * The **`length`** read-only property of the An integer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSUnparsedValue/length) + */ readonly length: number; forEach(callbackfn: (value: CSSUnparsedSegment, key: number, parent: CSSUnparsedValue) => void, thisArg?: any): void; [index: number]: CSSUnparsedSegment; @@ -6067,9 +7308,17 @@ declare var CSSUnparsedValue: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSVariableReferenceValue) */ interface CSSVariableReferenceValue { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSVariableReferenceValue/fallback) */ + /** + * The **`fallback`** read-only property of the A CSSUnparsedValue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSVariableReferenceValue/fallback) + */ readonly fallback: CSSUnparsedValue | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSVariableReferenceValue/variable) */ + /** + * The **`variable`** property of the A string beginning with `--` (that is, a custom property name). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSVariableReferenceValue/variable) + */ variable: string; } @@ -6095,19 +7344,47 @@ declare var CSSViewTransitionRule: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache) */ interface Cache { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/add) */ + /** + * The **`add()`** method of the Cache interface takes a URL, retrieves it, and adds the resulting response object to the given cache. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/add) + */ add(request: RequestInfo | URL): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll) */ + /** + * The **`addAll()`** method of the Cache interface takes an array of URLs, retrieves them, and adds the resulting response objects to the given cache. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll) + */ addAll(requests: RequestInfo[]): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/delete) */ + /** + * The **`delete()`** method of the Cache interface finds the Cache entry whose key is the request, and if found, deletes the Cache entry and returns a Promise that resolves to `true`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/delete) + */ delete(request: RequestInfo | URL, options?: CacheQueryOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/keys) */ + /** + * The **`keys()`** method of the Cache interface returns a representing the keys of the Cache. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/keys) + */ keys(request?: RequestInfo | URL, options?: CacheQueryOptions): Promise>; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/match) */ + /** + * The **`match()`** method of the Cache interface returns a Promise that resolves to the Response associated with the first matching request in the Cache object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/match) + */ match(request: RequestInfo | URL, options?: CacheQueryOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/matchAll) */ + /** + * The **`matchAll()`** method of the Cache interface returns a Promise that resolves to an array of all matching responses in the Cache object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/matchAll) + */ matchAll(request?: RequestInfo | URL, options?: CacheQueryOptions): Promise>; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/put) */ + /** + * The **`put()`** method of the Often, you will just want to Window/fetch one or more requests, then add the result straight to your cache. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/put) + */ put(request: RequestInfo | URL, response: Response): Promise; } @@ -6123,15 +7400,35 @@ declare var Cache: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage) */ interface CacheStorage { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/delete) */ + /** + * The **`delete()`** method of the CacheStorage interface finds the Cache object matching the `cacheName`, and if found, deletes the Cache object and returns a Promise that resolves to `true`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/delete) + */ delete(cacheName: string): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/has) */ + /** + * The **`has()`** method of the CacheStorage interface returns a Promise that resolves to `true` if a You can access `CacheStorage` through the Window.caches property in windows or through the WorkerGlobalScope.caches property in workers. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/has) + */ has(cacheName: string): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/keys) */ + /** + * The **`keys()`** method of the CacheStorage interface returns a Promise that will resolve with an array containing strings corresponding to all of the named Cache objects tracked by the CacheStorage object in the order they were created. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/keys) + */ keys(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/match) */ + /** + * The **`match()`** method of the CacheStorage interface checks if a given Request or URL string is a key for a stored Response. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/match) + */ match(request: RequestInfo | URL, options?: MultiCacheQueryOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/open) */ + /** + * The **`open()`** method of the the Cache object matching the `cacheName`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/open) + */ open(cacheName: string): Promise; } @@ -6146,9 +7443,17 @@ declare var CacheStorage: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasCaptureMediaStreamTrack) */ interface CanvasCaptureMediaStreamTrack extends MediaStreamTrack { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasCaptureMediaStreamTrack/canvas) */ + /** + * The **`canvas`** read-only property of the CanvasCaptureMediaStreamTrack interface returns the HTMLCanvasElement from which frames are being captured. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasCaptureMediaStreamTrack/canvas) + */ readonly canvas: HTMLCanvasElement; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasCaptureMediaStreamTrack/requestFrame) */ + /** + * The **`requestFrame()`** method of the CanvasCaptureMediaStreamTrack interface requests that a frame be captured from the canvas and sent to the stream. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasCaptureMediaStreamTrack/requestFrame) + */ requestFrame(): void; addEventListener(type: K, listener: (this: CanvasCaptureMediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -6222,9 +7527,7 @@ interface CanvasFilters { */ interface CanvasGradient { /** - * Adds a color stop with the given color to the gradient at the given offset. 0.0 is the offset at one end of the gradient, 1.0 is the offset at the other end. - * - * Throws an "IndexSizeError" DOMException if the offset is out of range. Throws a "SyntaxError" DOMException if the color cannot be parsed. + * The **`CanvasGradient.addColorStop()`** method adds a new color stop, defined by an `offset` and a `color`, to a given canvas gradient. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasGradient/addColorStop) */ @@ -6301,7 +7604,7 @@ interface CanvasPathDrawingStyles { */ interface CanvasPattern { /** - * Sets the transformation matrix that will be used when rendering the pattern during a fill or stroke painting operation. + * The **`CanvasPattern.setTransform()`** method uses a DOMMatrix object as the pattern's transformation matrix and invokes it on the pattern. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasPattern/setTransform) */ @@ -6328,7 +7631,11 @@ interface CanvasRect { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D) */ interface CanvasRenderingContext2D extends CanvasCompositing, CanvasDrawImage, CanvasDrawPath, CanvasFillStrokeStyles, CanvasFilters, CanvasImageData, CanvasImageSmoothing, CanvasPath, CanvasPathDrawingStyles, CanvasRect, CanvasSettings, CanvasShadowStyles, CanvasState, CanvasText, CanvasTextDrawingStyles, CanvasTransform, CanvasUserInterface { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/canvas) */ + /** + * The **`CanvasRenderingContext2D.canvas`** property, part of the Canvas API, is a read-only reference to the might be `null` if there is no associated canvas element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/canvas) + */ readonly canvas: HTMLCanvasElement; } @@ -6468,20 +7775,48 @@ declare var ChannelSplitterNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData) */ interface CharacterData extends Node, ChildNode, NonDocumentTypeChildNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/data) */ + /** + * The **`data`** property of the CharacterData interface represent the value of the current object's data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/data) + */ data: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/length) */ + /** + * The read-only **`CharacterData.length`** property returns the number of characters in the contained data, as a positive integer. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/length) + */ readonly length: number; readonly ownerDocument: Document; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/appendData) */ + /** + * The **`appendData()`** method of the CharacterData interface adds the provided data to the end of the node's current data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/appendData) + */ appendData(data: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/deleteData) */ + /** + * The **`deleteData()`** method of the CharacterData interface removes all or part of the data from this `CharacterData` node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/deleteData) + */ deleteData(offset: number, count: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/insertData) */ + /** + * The **`insertData()`** method of the CharacterData interface inserts the provided data into this `CharacterData` node's current data, at the provided offset from the start of the existing data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/insertData) + */ insertData(offset: number, data: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceData) */ + /** + * The **`replaceData()`** method of the CharacterData interface removes a certain number of characters of the existing text in a given `CharacterData` node and replaces those characters with the text provided. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceData) + */ replaceData(offset: number, count: number, data: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/substringData) */ + /** + * The **`substringData()`** method of the CharacterData interface returns a portion of the existing data, starting at the specified index and extending for a given number of characters afterwards. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/substringData) + */ substringData(offset: number, count: number): string; } @@ -6534,13 +7869,29 @@ interface ClientRect extends DOMRect { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard) */ interface Clipboard extends EventTarget { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/read) */ + /** + * The **`read()`** method of the Clipboard interface requests a copy of the clipboard's contents, fulfilling the returned Promise with the data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/read) + */ read(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/readText) */ + /** + * The **`readText()`** method of the Clipboard interface returns a Promise which fulfills with a copy of the textual contents of the system clipboard. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/readText) + */ readText(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/write) */ + /** + * The **`write()`** method of the Clipboard interface writes arbitrary ClipboardItem data such as images and text to the clipboard, fulfilling the returned Promise on completion. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/write) + */ write(data: ClipboardItems): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/writeText) */ + /** + * The **`writeText()`** method of the Clipboard interface writes the specified text to the system clipboard, returning a Promise that is resolved once the system clipboard has been updated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clipboard/writeText) + */ writeText(data: string): Promise; } @@ -6555,7 +7906,11 @@ declare var Clipboard: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardEvent) */ interface ClipboardEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardEvent/clipboardData) */ + /** + * The **`clipboardData`** property of the ClipboardEvent interface holds a DataTransfer object, which can be used to: - specify what data should be put into the clipboard from the Element/cut_event and Element/copy_event event handlers, typically with a DataTransfer.setData call; - obtain the data to be pasted from the Element/paste_event event handler, typically with a DataTransfer.getData call. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardEvent/clipboardData) + */ readonly clipboardData: DataTransfer | null; } @@ -6571,11 +7926,23 @@ declare var ClipboardEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem) */ interface ClipboardItem { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem/presentationStyle) */ + /** + * The read-only **`presentationStyle`** property of the ClipboardItem interface returns a string indicating how an item should be presented. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem/presentationStyle) + */ readonly presentationStyle: PresentationStyle; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem/types) */ + /** + * The read-only **`types`** property of the ClipboardItem interface returns an Array of MIME type available within the ClipboardItem. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem/types) + */ readonly types: ReadonlyArray; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem/getType) */ + /** + * The **`getType()`** method of the ClipboardItem interface returns a Promise that resolves with a Blob of the requested MIME type or an error if the MIME type is not found. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ClipboardItem/getType) + */ getType(type: string): Promise; } @@ -6593,19 +7960,19 @@ declare var ClipboardItem: { */ interface CloseEvent extends Event { /** - * Returns the WebSocket connection close code provided by the server. + * The **`code`** read-only property of the CloseEvent interface returns a WebSocket connection close code indicating the reason the connection was closed. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/code) */ readonly code: number; /** - * Returns the WebSocket connection close reason provided by the server. + * The **`reason`** read-only property of the CloseEvent interface returns the WebSocket connection close reason the server gave for closing the connection; that is, a concise human-readable prose explanation for the closure. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/reason) */ readonly reason: string; /** - * Returns true if the connection closed cleanly; false otherwise. + * The **`wasClean`** read-only property of the CloseEvent interface returns `true` if the connection closed cleanly. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/wasClean) */ @@ -6636,9 +8003,14 @@ declare var Comment: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompositionEvent) */ interface CompositionEvent extends UIEvent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompositionEvent/data) */ - readonly data: string; /** + * The **`data`** read-only property of the method that raised the event; its exact nature varies depending on the type of event that generated the `CompositionEvent` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompositionEvent/data) + */ + readonly data: string; + /** + * The **`initCompositionEvent()`** method of the CompositionEvent interface initializes the attributes of a `CompositionEvent` object instance. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompositionEvent/initCompositionEvent) @@ -6672,7 +8044,11 @@ declare var CompressionStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConstantSourceNode) */ interface ConstantSourceNode extends AudioScheduledSourceNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConstantSourceNode/offset) */ + /** + * The read-only `offset` property of the ConstantSourceNode interface returns a AudioParam object indicating the numeric a-rate value which is always returned by the source when asked for the next sample. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConstantSourceNode/offset) + */ readonly offset: AudioParam; addEventListener(type: K, listener: (this: ConstantSourceNode, ev: AudioScheduledSourceNodeEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -6691,7 +8067,11 @@ declare var ConstantSourceNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ContentVisibilityAutoStateChangeEvent) */ interface ContentVisibilityAutoStateChangeEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ContentVisibilityAutoStateChangeEvent/skipped) */ + /** + * The `skipped` read-only property of the ContentVisibilityAutoStateChangeEvent interface returns `true` if the user agent skips the element's contents, or `false` otherwise. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ContentVisibilityAutoStateChangeEvent/skipped) + */ readonly skipped: boolean; } @@ -6706,9 +8086,17 @@ declare var ContentVisibilityAutoStateChangeEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConvolverNode) */ interface ConvolverNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConvolverNode/buffer) */ + /** + * The **`buffer`** property of the ConvolverNode interface represents a mono, stereo, or 4-channel AudioBuffer containing the (possibly multichannel) impulse response used by the `ConvolverNode` to create the reverb effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConvolverNode/buffer) + */ buffer: AudioBuffer | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConvolverNode/normalize) */ + /** + * The `normalize` property of the ConvolverNode interface is a boolean that controls whether the impulse response from the buffer will be scaled by an equal-power normalization when the `buffer` attribute is set, or not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ConvolverNode/normalize) + */ normalize: boolean; } @@ -6724,9 +8112,17 @@ declare var ConvolverNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieChangeEvent) */ interface CookieChangeEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieChangeEvent/changed) */ + /** + * The **`changed`** read-only property of the CookieChangeEvent interface returns an array of the cookies that have been changed. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieChangeEvent/changed) + */ readonly changed: ReadonlyArray; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieChangeEvent/deleted) */ + /** + * The **`deleted`** read-only property of the CookieChangeEvent interface returns an array of the cookies that have been deleted by the given `CookieChangeEvent` instance. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieChangeEvent/deleted) + */ readonly deleted: ReadonlyArray; } @@ -6748,16 +8144,32 @@ interface CookieStoreEventMap { interface CookieStore extends EventTarget { /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/change_event) */ onchange: ((this: CookieStore, ev: CookieChangeEvent) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/delete) */ + /** + * The **`delete()`** method of the CookieStore interface deletes a cookie that matches the given `name` or `options` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/delete) + */ delete(name: string): Promise; delete(options: CookieStoreDeleteOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/get) */ + /** + * The **`get()`** method of the CookieStore interface returns a Promise that resolves to a single cookie matching the given `name` or `options` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/get) + */ get(name: string): Promise; get(options?: CookieStoreGetOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/getAll) */ + /** + * The **`getAll()`** method of the CookieStore interface returns a Promise that resolves as an array of cookies that match the `name` or `options` passed to it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/getAll) + */ getAll(name: string): Promise; getAll(options?: CookieStoreGetOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/set) */ + /** + * The **`set()`** method of the CookieStore interface sets a cookie with the given `name` and `value` or `options` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStore/set) + */ set(name: string, value: string): Promise; set(options: CookieInit): Promise; addEventListener(type: K, listener: (this: CookieStore, ev: CookieStoreEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; @@ -6777,9 +8189,17 @@ declare var CookieStore: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy) */ interface CountQueuingStrategy extends QueuingStrategy { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/highWaterMark) */ + /** + * The read-only **`CountQueuingStrategy.highWaterMark`** property returns the total number of chunks that can be contained in the internal queue before backpressure is applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/highWaterMark) + */ readonly highWaterMark: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/size) */ + /** + * The **`size()`** method of the total queue size is a count of the number of chunks in the queue. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/size) + */ readonly size: QueuingStrategySize; } @@ -6795,9 +8215,17 @@ declare var CountQueuingStrategy: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Credential) */ interface Credential { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Credential/id) */ + /** + * The **`id`** read-only property of the Credential interface returns a string containing the credential's identifier. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Credential/id) + */ readonly id: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Credential/type) */ + /** + * The **`type`** read-only property of the Credential interface returns a string containing the credential's type. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Credential/type) + */ readonly type: string; } @@ -6813,13 +8241,29 @@ declare var Credential: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer) */ interface CredentialsContainer { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/create) */ + /** + * The **`create()`** method of the CredentialsContainer interface creates a new credential, which can then be stored and later retrieved using the CredentialsContainer.get method. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/create) + */ create(options?: CredentialCreationOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/get) */ + /** + * The **`get()`** method of the CredentialsContainer interface returns a Promise that fulfills with a single credential, which can then be used to authenticate a user to a website. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/get) + */ get(options?: CredentialRequestOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/preventSilentAccess) */ + /** + * The **`preventSilentAccess()`** method of the CredentialsContainer interface sets a flag that specifies whether automatic log in is allowed for future visits to the current origin, then returns a Promise that resolves to `undefined`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/preventSilentAccess) + */ preventSilentAccess(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/store) */ + /** + * The **`store()`** method of the ```js-nolint store(credentials) ``` - `credentials` - : A valid Credential instance. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CredentialsContainer/store) + */ store(credential: Credential): Promise; } @@ -6835,14 +8279,20 @@ declare var CredentialsContainer: { */ interface Crypto { /** + * The **`Crypto.subtle`** read-only property returns a cryptographic operations. * Available only in secure contexts. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/subtle) */ readonly subtle: SubtleCrypto; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/getRandomValues) */ + /** + * The **`Crypto.getRandomValues()`** method lets you get cryptographically strong random values. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/getRandomValues) + */ getRandomValues(array: T): T; /** + * The **`randomUUID()`** method of the Crypto interface is used to generate a v4 UUID using a cryptographically secure random number generator. * Available only in secure contexts. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/randomUUID) @@ -6862,13 +8312,29 @@ declare var Crypto: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey) */ interface CryptoKey { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/algorithm) */ + /** + * The read-only **`algorithm`** property of the CryptoKey interface returns an object describing the algorithm for which this key can be used, and any associated extra parameters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/algorithm) + */ readonly algorithm: KeyAlgorithm; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/extractable) */ + /** + * The read-only **`extractable`** property of the CryptoKey interface indicates whether or not the key may be extracted using `SubtleCrypto.exportKey()` or `SubtleCrypto.wrapKey()`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/extractable) + */ readonly extractable: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/type) */ + /** + * The read-only **`type`** property of the CryptoKey interface indicates which kind of key is represented by the object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/type) + */ readonly type: KeyType; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/usages) */ + /** + * The read-only **`usages`** property of the CryptoKey interface indicates what can be done with the key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/usages) + */ readonly usages: KeyUsage[]; } @@ -6883,15 +8349,35 @@ declare var CryptoKey: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry) */ interface CustomElementRegistry { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/define) */ + /** + * The **`define()`** method of the CustomElementRegistry interface adds a definition for a custom element to the custom element registry, mapping its name to the constructor which will be used to create it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/define) + */ define(name: string, constructor: CustomElementConstructor, options?: ElementDefinitionOptions): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/get) */ + /** + * The **`get()`** method of the previously-defined custom element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/get) + */ get(name: string): CustomElementConstructor | undefined; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/getName) */ + /** + * The **`getName()`** method of the previously-defined custom element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/getName) + */ getName(constructor: CustomElementConstructor): string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/upgrade) */ + /** + * The **`upgrade()`** method of the elements in a Node subtree, even before they are connected to the main document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/upgrade) + */ upgrade(root: Node): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/whenDefined) */ + /** + * The **`whenDefined()`** method of the resolves when the named element is defined. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/whenDefined) + */ whenDefined(name: string): Promise; } @@ -6907,12 +8393,13 @@ declare var CustomElementRegistry: { */ interface CustomEvent extends Event { /** - * Returns any custom data event was created with. Typically used for synthetic events. + * The read-only **`detail`** property of the CustomEvent interface returns any data passed when initializing the event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) */ readonly detail: T; /** + * The **`CustomEvent.initCustomEvent()`** method initializes a CustomEvent object. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/initCustomEvent) @@ -6946,14 +8433,23 @@ declare var CustomStateSet: { */ interface DOMException extends Error { /** + * The **`code`** read-only property of the DOMException interface returns one of the legacy error code constants, or `0` if none match. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/code) */ readonly code: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message) */ + /** + * The **`message`** read-only property of the a message or description associated with the given error name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message) + */ readonly message: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name) */ + /** + * The **`name`** read-only property of the one of the strings associated with an error name. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name) + */ readonly name: string; readonly INDEX_SIZE_ERR: 1; readonly DOMSTRING_SIZE_ERR: 2; @@ -7018,13 +8514,26 @@ declare var DOMException: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation) */ interface DOMImplementation { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/createDocument) */ + /** + * The **`DOMImplementation.createDocument()`** method creates and returns an XMLDocument. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/createDocument) + */ createDocument(namespace: string | null, qualifiedName: string | null, doctype?: DocumentType | null): XMLDocument; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/createDocumentType) */ + /** + * The **`DOMImplementation.createDocumentType()`** method returns a DocumentType object which can either be used with into the document via methods like Node.insertBefore() or ```js-nolint createDocumentType(qualifiedNameStr, publicId, systemId) ``` - `qualifiedNameStr` - : A string containing the qualified name, like `svg:svg`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/createDocumentType) + */ createDocumentType(qualifiedName: string, publicId: string, systemId: string): DocumentType; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/createHTMLDocument) */ + /** + * The **`DOMImplementation.createHTMLDocument()`** method creates a new HTML Document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/createHTMLDocument) + */ createHTMLDocument(title?: string): Document; /** + * The **`DOMImplementation.hasFeature()`** method returns a boolean flag indicating if a given feature is supported. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMImplementation/hasFeature) @@ -7087,29 +8596,77 @@ interface DOMMatrix extends DOMMatrixReadOnly { m43: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix#instance_properties) */ m44: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/invertSelf) */ + /** + * The **`invertSelf()`** method of the DOMMatrix interface inverts the original matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/invertSelf) + */ invertSelf(): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/multiplySelf) */ + /** + * The **`multiplySelf()`** method of the DOMMatrix interface multiplies a matrix by the `otherMatrix` parameter, computing the dot product of the original matrix and the specified matrix: `Aโ‹…B`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/multiplySelf) + */ multiplySelf(other?: DOMMatrixInit): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/preMultiplySelf) */ + /** + * The **`preMultiplySelf()`** method of the DOMMatrix interface modifies the matrix by pre-multiplying it with the specified `DOMMatrix`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/preMultiplySelf) + */ preMultiplySelf(other?: DOMMatrixInit): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/rotateAxisAngleSelf) */ + /** + * The `rotateAxisAngleSelf()` method of the DOMMatrix interface is a transformation method that rotates the source matrix by the given vector and angle, returning the altered matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/rotateAxisAngleSelf) + */ rotateAxisAngleSelf(x?: number, y?: number, z?: number, angle?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/rotateFromVectorSelf) */ + /** + * The `rotateFromVectorSelf()` method of the DOMMatrix interface is a mutable transformation method that modifies a matrix by rotating the matrix by the angle between the specified vector and `(1, 0)`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/rotateFromVectorSelf) + */ rotateFromVectorSelf(x?: number, y?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/rotateSelf) */ + /** + * The `rotateSelf()` method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/rotateSelf) + */ rotateSelf(rotX?: number, rotY?: number, rotZ?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/scale3dSelf) */ + /** + * The **`scale3dSelf()`** method of the DOMMatrix interface is a mutable transformation method that modifies a matrix by applying a specified scaling factor to all three axes, centered on the given origin, with a default origin of `(0, 0, 0)`, returning the 3D-scaled matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/scale3dSelf) + */ scale3dSelf(scale?: number, originX?: number, originY?: number, originZ?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/scaleSelf) */ + /** + * The **`scaleSelf()`** method of the DOMMatrix interface is a mutable transformation method that modifies a matrix by applying a specified scaling factor, centered on the given origin, with a default origin of `(0, 0)`, returning the scaled matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/scaleSelf) + */ scaleSelf(scaleX?: number, scaleY?: number, scaleZ?: number, originX?: number, originY?: number, originZ?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/setMatrixValue) */ + /** + * The **`setMatrixValue()`** method of the DOMMatrix interface replaces the contents of the matrix with the matrix described by the specified transform or transforms, returning itself. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/setMatrixValue) + */ setMatrixValue(transformList: string): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/skewXSelf) */ + /** + * The `skewXSelf()` method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/skewXSelf) + */ skewXSelf(sx?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/skewYSelf) */ + /** + * The `skewYSelf()` method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/skewYSelf) + */ skewYSelf(sy?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/translateSelf) */ + /** + * The `translateSelf()` method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrix/translateSelf) + */ translateSelf(tx?: number, ty?: number, tz?: number): DOMMatrix; } @@ -7145,9 +8702,17 @@ interface DOMMatrixReadOnly { readonly e: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly#instance_properties) */ readonly f: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/is2D) */ + /** + * The readonly **`is2D`** property of the DOMMatrixReadOnly interface is a Boolean flag that is `true` when the matrix is 2D. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/is2D) + */ readonly is2D: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/isIdentity) */ + /** + * The readonly **`isIdentity`** property of the DOMMatrixReadOnly interface is a Boolean whose value is `true` if the matrix is the identity matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/isIdentity) + */ readonly isIdentity: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly#instance_properties) */ readonly m11: number; @@ -7181,39 +8746,103 @@ interface DOMMatrixReadOnly { readonly m43: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly#instance_properties) */ readonly m44: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/flipX) */ + /** + * The **`flipX()`** method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix flipped about the x-axis. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/flipX) + */ flipX(): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/flipY) */ + /** + * The **`flipY()`** method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix flipped about the y-axis. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/flipY) + */ flipY(): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/inverse) */ + /** + * The **`inverse()`** method of the DOMMatrixReadOnly interface creates a new matrix which is the inverse of the original matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/inverse) + */ inverse(): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/multiply) */ + /** + * The **`multiply()`** method of the DOMMatrixReadOnly interface creates and returns a new matrix which is the dot product of the matrix and the `otherMatrix` parameter. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/multiply) + */ multiply(other?: DOMMatrixInit): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/rotate) */ + /** + * The `rotate()` method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by rotating the source matrix around each of its axes by the specified number of degrees. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/rotate) + */ rotate(rotX?: number, rotY?: number, rotZ?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/rotateAxisAngle) */ + /** + * The `rotateAxisAngle()` method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by rotating the source matrix by the given vector and angle. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/rotateAxisAngle) + */ rotateAxisAngle(x?: number, y?: number, z?: number, angle?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/rotateFromVector) */ + /** + * The `rotateFromVector()` method of the DOMMatrixReadOnly interface is returns a new DOMMatrix created by rotating the source matrix by the angle between the specified vector and `(1, 0)`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/rotateFromVector) + */ rotateFromVector(x?: number, y?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/scale) */ + /** + * The **`scale()`** method of the original matrix with a scale transform applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/scale) + */ scale(scaleX?: number, scaleY?: number, scaleZ?: number, originX?: number, originY?: number, originZ?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/scale3d) */ + /** + * The **`scale3d()`** method of the DOMMatrixReadOnly interface creates a new matrix which is the result of a 3D scale transform being applied to the matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/scale3d) + */ scale3d(scale?: number, originX?: number, originY?: number, originZ?: number): DOMMatrix; /** @deprecated */ scaleNonUniform(scaleX?: number, scaleY?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/skewX) */ + /** + * The `skewX()` method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by applying the specified skew transformation to the source matrix along its x-axis. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/skewX) + */ skewX(sx?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/skewY) */ + /** + * The `skewY()` method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by applying the specified skew transformation to the source matrix along its y-axis. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/skewY) + */ skewY(sy?: number): DOMMatrix; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/toFloat32Array) */ + /** + * The **`toFloat32Array()`** method of the DOMMatrixReadOnly interface returns a new Float32Array containing all 16 elements (`m11`, `m12`, `m13`, `m14`, `m21`, `m22`, `m23`, `m24`, `m31`, `m32`, `m33`, `m34`, `m41`, `m42`, `m43`, `m44`) which comprise the matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/toFloat32Array) + */ toFloat32Array(): Float32Array; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/toFloat64Array) */ + /** + * The **`toFloat64Array()`** method of the DOMMatrixReadOnly interface returns a new Float64Array containing all 16 elements (`m11`, `m12`, `m13`, `m14`, `m21`, `m22`, `m23`, `m24`, `m31`, `m32`, `m33`, `m34`, `m41`, `m42`, `m43`, `m44`) which comprise the matrix. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/toFloat64Array) + */ toFloat64Array(): Float64Array; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/toJSON) */ + /** + * The **`toJSON()`** method of the DOMMatrixReadOnly interface creates and returns a JSON object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/toJSON) + */ toJSON(): any; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/transformPoint) */ + /** + * The **`transformPoint`** method of the You can also create a new `DOMPoint` by applying a matrix to a point with the DOMPointReadOnly.matrixTransform() method. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/transformPoint) + */ transformPoint(point?: DOMPointInit): DOMPoint; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/translate) */ + /** + * The `translate()` method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix with a translation applied. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMMatrixReadOnly/translate) + */ translate(tx?: number, ty?: number, tz?: number): DOMMatrix; toString(): string; } @@ -7233,13 +8862,7 @@ declare var DOMMatrixReadOnly: { */ interface DOMParser { /** - * Parses string using either the HTML or XML parser, according to type, and returns the resulting Document. type can be "text/html" (which will invoke the HTML parser), or any of "text/xml", "application/xml", "application/xhtml+xml", or "image/svg+xml" (which will invoke the XML parser). - * - * For the XML parser, if string cannot be parsed, then the returned Document will contain elements describing the resulting error. - * - * Note that script elements are not evaluated during parsing, and the resulting document's encoding will always be UTF-8. - * - * Values other than the above for type will cause a TypeError exception to be thrown. + * The **`parseFromString()`** method of the DOMParser interface parses a string containing either HTML or XML, returning an HTMLDocument or an XMLDocument. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMParser/parseFromString) */ @@ -7257,13 +8880,29 @@ declare var DOMParser: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint) */ interface DOMPoint extends DOMPointReadOnly { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/w) */ + /** + * The **`DOMPoint`** interface's **`w`** property holds the point's perspective value, w, for a point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/w) + */ w: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/x) */ + /** + * The **`DOMPoint`** interface's **`x`** property holds the horizontal coordinate, x, for a point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/x) + */ x: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/y) */ + /** + * The **`DOMPoint`** interface's **`y`** property holds the vertical coordinate, _y_, for a point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/y) + */ y: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/z) */ + /** + * The **`DOMPoint`** interface's **`z`** property specifies the depth coordinate of a point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/z) + */ z: number; } @@ -7283,17 +8922,41 @@ declare var SVGPoint: typeof DOMPoint; * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly) */ interface DOMPointReadOnly { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/w) */ + /** + * The **`DOMPointReadOnly`** interface's **`w`** property holds the point's perspective value, `w`, for a read-only point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/w) + */ readonly w: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/x) */ + /** + * The **`DOMPointReadOnly`** interface's **`x`** property holds the horizontal coordinate, x, for a read-only point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/x) + */ readonly x: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y) */ + /** + * The **`DOMPointReadOnly`** interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y) + */ readonly y: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/z) */ + /** + * The **`DOMPointReadOnly`** interface's **`z`** property holds the depth coordinate, z, for a read-only point in space. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/z) + */ readonly z: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/matrixTransform) */ + /** + * The **`matrixTransform()`** method of the DOMPointReadOnly interface applies a matrix transform specified as an object to the DOMPointReadOnly object, creating and returning a new `DOMPointReadOnly` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/matrixTransform) + */ matrixTransform(matrix?: DOMMatrixInit): DOMPoint; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/toJSON) */ + /** + * The DOMPointReadOnly method `toJSON()` returns an object giving the ```js-nolint toJSON() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/toJSON) + */ toJSON(): any; } @@ -7310,17 +8973,41 @@ declare var DOMPointReadOnly: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad) */ interface DOMQuad { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p1) */ + /** + * The **`DOMQuad`** interface's **`p1`** property holds the DOMPoint object that represents one of the four corners of the `DOMQuad`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p1) + */ readonly p1: DOMPoint; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p2) */ + /** + * The **`DOMQuad`** interface's **`p2`** property holds the DOMPoint object that represents one of the four corners of the `DOMQuad`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p2) + */ readonly p2: DOMPoint; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p3) */ + /** + * The **`DOMQuad`** interface's **`p3`** property holds the DOMPoint object that represents one of the four corners of the `DOMQuad`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p3) + */ readonly p3: DOMPoint; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p4) */ + /** + * The **`DOMQuad`** interface's **`p4`** property holds the DOMPoint object that represents one of the four corners of the `DOMQuad`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/p4) + */ readonly p4: DOMPoint; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/getBounds) */ + /** + * The DOMQuad method `getBounds()` returns a DOMRect object representing the smallest rectangle that fully contains the `DOMQuad` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/getBounds) + */ getBounds(): DOMRect; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/toJSON) */ + /** + * The DOMQuad method `toJSON()` returns a ```js-nolint toJSON() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMQuad/toJSON) + */ toJSON(): any; } @@ -7337,13 +9024,29 @@ declare var DOMQuad: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect) */ interface DOMRect extends DOMRectReadOnly { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/height) */ + /** + * The **`height`** property of the DOMRect interface represents the height of the rectangle. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/height) + */ height: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/width) */ + /** + * The **`width`** property of the DOMRect interface represents the width of the rectangle. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/width) + */ width: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/x) */ + /** + * The **`x`** property of the DOMRect interface represents the x-coordinate of the rectangle, which is the horizontal distance between the viewport's left edge and the rectangle's origin. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/x) + */ x: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/y) */ + /** + * The **`y`** property of the DOMRect interface represents the y-coordinate of the rectangle, which is the vertical distance between the viewport's top edge and the rectangle's origin. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/y) + */ y: number; } @@ -7363,9 +9066,17 @@ declare var SVGRect: typeof DOMRect; * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectList) */ interface DOMRectList { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectList/length) */ + /** + * The read-only **`length`** property of the DOMRectList interface returns the number of DOMRect objects in the list. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectList/length) + */ readonly length: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectList/item) */ + /** + * The DOMRectList method `item()` returns the DOMRect at the specified index within the list, or `null` if the index is out of range. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectList/item) + */ item(index: number): DOMRect | null; [index: number]: DOMRect; } @@ -7381,23 +9092,59 @@ declare var DOMRectList: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly) */ interface DOMRectReadOnly { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/bottom) */ + /** + * The **`bottom`** read-only property of the **`DOMRectReadOnly`** interface returns the bottom coordinate value of the `DOMRect`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/bottom) + */ readonly bottom: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/height) */ + /** + * The **`height`** read-only property of the **`DOMRectReadOnly`** interface represents the height of the `DOMRect`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/height) + */ readonly height: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/left) */ + /** + * The **`left`** read-only property of the **`DOMRectReadOnly`** interface returns the left coordinate value of the `DOMRect`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/left) + */ readonly left: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/right) */ + /** + * The **`right`** read-only property of the **`DOMRectReadOnly`** interface returns the right coordinate value of the `DOMRect`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/right) + */ readonly right: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/top) */ + /** + * The **`top`** read-only property of the **`DOMRectReadOnly`** interface returns the top coordinate value of the `DOMRect`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/top) + */ readonly top: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/width) */ + /** + * The **`width`** read-only property of the **`DOMRectReadOnly`** interface represents the width of the `DOMRect`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/width) + */ readonly width: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/x) */ + /** + * The **`x`** read-only property of the **`DOMRectReadOnly`** interface represents the x coordinate of the `DOMRect`'s origin. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/x) + */ readonly x: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/y) */ + /** + * The **`y`** read-only property of the **`DOMRectReadOnly`** interface represents the y coordinate of the `DOMRect`'s origin. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/y) + */ readonly y: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/toJSON) */ + /** + * The DOMRectReadOnly method `toJSON()` returns a JSON representation of the `DOMRectReadOnly` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/toJSON) + */ toJSON(): any; } @@ -7415,19 +9162,19 @@ declare var DOMRectReadOnly: { */ interface DOMStringList { /** - * Returns the number of strings in strings. + * The read-only **`length`** property indicates the number of strings in the DOMStringList. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMStringList/length) */ readonly length: number; /** - * Returns true if strings contains string, and false otherwise. + * The **`contains()`** method returns a boolean indicating whether the given string is in the list. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMStringList/contains) */ contains(string: string): boolean; /** - * Returns the string with index index from strings. + * The **`item()`** method returns a string from a `DOMStringList` by index. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMStringList/item) */ @@ -7461,80 +9208,56 @@ declare var DOMStringMap: { */ interface DOMTokenList { /** - * Returns the number of tokens. + * The read-only **`length`** property of the DOMTokenList interface is an `integer` representing the number of objects stored in the object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/length) */ readonly length: number; /** - * Returns the associated set as string. - * - * Can be set, to change the associated attribute. + * The **`value`** property of the DOMTokenList interface is a stringifier that returns the value of the list serialized as a string, or clears and sets the list to the given value. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/value) */ value: string; toString(): string; /** - * Adds all arguments passed, except those already present. - * - * Throws a "SyntaxError" DOMException if one of the arguments is the empty string. - * - * Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace. + * The **`add()`** method of the DOMTokenList interface adds the given tokens to the list, omitting any that are already present. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/add) */ add(...tokens: string[]): void; /** - * Returns true if token is present, and false otherwise. + * The **`contains()`** method of the DOMTokenList interface returns a boolean value โ€” `true` if the underlying list contains the given token, otherwise `false`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/contains) */ contains(token: string): boolean; /** - * Returns the token with index index. + * The **`item()`** method of the DOMTokenList interface returns an item in the list, determined by its position in the list, its index. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/item) */ item(index: number): string | null; /** - * Removes arguments passed, if they are present. - * - * Throws a "SyntaxError" DOMException if one of the arguments is the empty string. - * - * Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace. + * The **`remove()`** method of the DOMTokenList interface removes the specified _tokens_ from the list. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/remove) */ remove(...tokens: string[]): void; /** - * Replaces token with newToken. - * - * Returns true if token was replaced with newToken, and false otherwise. - * - * Throws a "SyntaxError" DOMException if one of the arguments is the empty string. - * - * Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace. + * The **`replace()`** method of the DOMTokenList interface replaces an existing token with a new token. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/replace) */ replace(token: string, newToken: string): boolean; /** - * Returns true if token is in the associated attribute's supported tokens. Returns false otherwise. - * - * Throws a TypeError if the associated attribute has no supported tokens defined. + * The **`supports()`** method of the DOMTokenList interface returns `true` if a given `token` is in the associated attribute's supported tokens. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/supports) */ supports(token: string): boolean; /** - * If force is not given, "toggles" token, removing it if it's present and adding it if it's not present. If force is true, adds token (same as add()). If force is false, removes token (same as remove()). - * - * Returns true if token is now present, and false otherwise. - * - * Throws a "SyntaxError" DOMException if token is empty. - * - * Throws an "InvalidCharacterError" DOMException if token contains any spaces. + * The **`toggle()`** method of the DOMTokenList interface removes an existing token from the list and returns `false`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMTokenList/toggle) */ @@ -7555,63 +9278,55 @@ declare var DOMTokenList: { */ interface DataTransfer { /** - * Returns the kind of operation that is currently selected. If the kind of operation isn't one of those that is allowed by the effectAllowed attribute, then the operation will fail. - * - * Can be set, to change the selected operation. - * - * The possible values are "none", "copy", "link", and "move". + * The **`DataTransfer.dropEffect`** property controls the feedback (typically visual) the user is given during a drag and drop operation. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/dropEffect) */ dropEffect: "none" | "copy" | "link" | "move"; /** - * Returns the kinds of operations that are to be allowed. - * - * Can be set (during the dragstart event), to change the allowed operations. - * - * The possible values are "none", "copy", "copyLink", "copyMove", "link", "linkMove", "move", "all", and "uninitialized", + * The **`DataTransfer.effectAllowed`** property specifies the effect that is allowed for a drag operation. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/effectAllowed) */ effectAllowed: "none" | "copy" | "copyLink" | "copyMove" | "link" | "linkMove" | "move" | "all" | "uninitialized"; /** - * Returns a FileList of the files being dragged, if any. + * The **`files`** read-only property of `DataTransfer` objects is a list of the files in the drag operation. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/files) */ readonly files: FileList; /** - * Returns a DataTransferItemList object, with the drag data. + * The read-only `items` property of the DataTransfer interface is a A DataTransferItemList object containing DataTransferItem objects representing the items being dragged in a drag operation, one list item for each object being dragged. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/items) */ readonly items: DataTransferItemList; /** - * Returns a frozen array listing the formats that were set in the dragstart event. In addition, if any files are being dragged, then one of the types will be the string "Files". + * The **`DataTransfer.types`** read-only property returns the available types that exist in the DataTransfer.items. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/types) */ readonly types: ReadonlyArray; /** - * Removes the data of the specified formats. Removes all data if the argument is omitted. + * The **`DataTransfer.clearData()`** method removes the drag operation's drag data for the given type. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/clearData) */ clearData(format?: string): void; /** - * Returns the specified data. If there is no such data, returns the empty string. + * The **`DataTransfer.getData()`** method retrieves drag data (as a string) for the specified type. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/getData) */ getData(format: string): string; /** - * Adds the specified data. + * The **`DataTransfer.setData()`** method sets the drag operation's drag data to the specified data and type. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/setData) */ setData(format: string, data: string): void; /** - * Uses the given element to update the drag feedback, replacing any previously specified feedback. + * When a drag occurs, a translucent image is generated from the drag target (the element the HTMLElement/dragstart_event event is fired at), and follows the mouse pointer during the drag. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransfer/setDragImage) */ @@ -7630,30 +9345,34 @@ declare var DataTransfer: { */ interface DataTransferItem { /** - * Returns the drag data item kind, one of: "string", "file". + * The read-only **`DataTransferItem.kind`** property returns the kindโ€“a string or a fileโ€“of the DataTransferItem object representing the _drag data item_. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItem/kind) */ readonly kind: string; /** - * Returns the drag data item type string. + * The read-only **`DataTransferItem.type`** property returns the type (format) of the DataTransferItem object representing the drag data item. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItem/type) */ readonly type: string; /** - * Returns a File object, if the drag data item kind is File. + * If the item is a file, the **`DataTransferItem.getAsFile()`** method returns the drag data item's File object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItem/getAsFile) */ getAsFile(): File | null; /** - * Invokes the callback with the string data as the argument, if the drag data item kind is text. + * The **`DataTransferItem.getAsString()`** method invokes the given callback with the drag data item's string data as the argument if the item's DataTransferItem.kind is a _Plain unicode string_ (i.e., `kind` is `string`). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItem/getAsString) */ getAsString(callback: FunctionStringCallback | null): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItem/webkitGetAsEntry) */ + /** + * If the item described by the DataTransferItem is a file, `webkitGetAsEntry()` returns a FileSystemFileEntry or FileSystemDirectoryEntry representing it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItem/webkitGetAsEntry) + */ webkitGetAsEntry(): FileSystemEntry | null; } @@ -7669,26 +9388,26 @@ declare var DataTransferItem: { */ interface DataTransferItemList { /** - * Returns the number of items in the drag data store. + * The read-only **`length`** property of the the drag item list. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItemList/length) */ readonly length: number; /** - * Adds a new entry for the given data to the drag data store. If the data is plain text then a type string has to be provided also. + * The **`DataTransferItemList.add()`** method creates a new list. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItemList/add) */ add(data: string, type: string): DataTransferItem | null; add(data: File): DataTransferItem | null; /** - * Removes all the entries in the drag data store. + * The DataTransferItemList method **`clear()`** removes all DataTransferItem objects from the drag data items list, leaving the list empty. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItemList/clear) */ clear(): void; /** - * Removes the indexth entry in the drag data store. + * The **`DataTransferItemList.remove()`** method removes the less than zero or greater than one less than the length of the list, the list will not be changed. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DataTransferItemList/remove) */ @@ -7722,7 +9441,11 @@ declare var DecompressionStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DelayNode) */ interface DelayNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DelayNode/delayTime) */ + /** + * The `delayTime` property of the DelayNode interface is an a-rate AudioParam representing the amount of delay to apply. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DelayNode/delayTime) + */ readonly delayTime: AudioParam; } @@ -7738,13 +9461,29 @@ declare var DelayNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent) */ interface DeviceMotionEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/acceleration) */ + /** + * The **`acceleration`** read-only property of the DeviceMotionEvent interface returns the acceleration recorded by the device, in meters per second squared (m/sยฒ). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/acceleration) + */ readonly acceleration: DeviceMotionEventAcceleration | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/accelerationIncludingGravity) */ + /** + * The **`accelerationIncludingGravity`** read-only property of the DeviceMotionEvent interface returns the amount of acceleration recorded by the device, in meters per second squared (m/sยฒ). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/accelerationIncludingGravity) + */ readonly accelerationIncludingGravity: DeviceMotionEventAcceleration | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/interval) */ + /** + * The **`interval`** read-only property of the DeviceMotionEvent interface returns the interval, in milliseconds, at which data is obtained from the underlying hardware. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/interval) + */ readonly interval: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/rotationRate) */ + /** + * The **`rotationRate`** read-only property of the DeviceMotionEvent interface returns the rate at which the device is rotating around each of its axes in degrees per second. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEvent/rotationRate) + */ readonly rotationRate: DeviceMotionEventRotationRate | null; } @@ -7760,11 +9499,23 @@ declare var DeviceMotionEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration) */ interface DeviceMotionEventAcceleration { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration/x) */ + /** + * The **`x`** read-only property of the DeviceMotionEventAcceleration interface indicates the amount of acceleration that occurred along the X axis in a `DeviceMotionEventAcceleration` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration/x) + */ readonly x: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration/y) */ + /** + * The **`y`** read-only property of the DeviceMotionEventAcceleration interface indicates the amount of acceleration that occurred along the Y axis in a `DeviceMotionEventAcceleration` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration/y) + */ readonly y: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration/z) */ + /** + * The **`z`** read-only property of the DeviceMotionEventAcceleration interface indicates the amount of acceleration that occurred along the Z axis in a `DeviceMotionEventAcceleration` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventAcceleration/z) + */ readonly z: number | null; } @@ -7775,11 +9526,23 @@ interface DeviceMotionEventAcceleration { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate) */ interface DeviceMotionEventRotationRate { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate/alpha) */ + /** + * The **`alpha`** read-only property of the DeviceMotionEventRotationRate interface indicates the rate of rotation around the Z axis, in degrees per second. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate/alpha) + */ readonly alpha: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate/beta) */ + /** + * The **`beta`** read-only property of the DeviceMotionEventRotationRate interface indicates the rate of rotation around the X axis, in degrees per second. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate/beta) + */ readonly beta: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate/gamma) */ + /** + * The **`gamma`** read-only property of the DeviceMotionEventRotationRate interface indicates the rate of rotation around the Y axis, in degrees per second. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceMotionEventRotationRate/gamma) + */ readonly gamma: number | null; } @@ -7790,13 +9553,29 @@ interface DeviceMotionEventRotationRate { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent) */ interface DeviceOrientationEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/absolute) */ + /** + * The **`absolute`** read-only property of the DeviceOrientationEvent interface indicates whether or not the device is providing orientation data absolutely (that is, in reference to the Earth's coordinate frame) or using some arbitrary frame determined by the device. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/absolute) + */ readonly absolute: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/alpha) */ + /** + * The **`alpha`** read-only property of the DeviceOrientationEvent interface returns the rotation of the device around the Z axis; that is, the number of degrees by which the device is being twisted around the center of the screen. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/alpha) + */ readonly alpha: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/beta) */ + /** + * The **`beta`** read-only property of the DeviceOrientationEvent interface returns the rotation of the device around the X axis; that is, the number of degrees, ranged between -180 and 180, by which the device is tipped forward or backward. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/beta) + */ readonly beta: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/gamma) */ + /** + * The **`gamma`** read-only property of the DeviceOrientationEvent interface returns the rotation of the device around the Y axis; that is, the number of degrees, ranged between `-90` and `90`, by which the device is tilted left or right. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DeviceOrientationEvent/gamma) + */ readonly gamma: number | null; } @@ -7822,219 +9601,220 @@ interface DocumentEventMap extends GlobalEventHandlersEventMap { */ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEventHandlers, NonElementParentNode, ParentNode, XPathEvaluatorBase { /** - * Sets or gets the URL for the current document. + * The **`URL`** read-only property of the Document interface returns the document location as a string. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/URL) */ readonly URL: string; /** - * Sets or gets the color of all active links in the document. + * Returns or sets the color of an active link in the document body. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/alinkColor) */ alinkColor: string; /** - * Returns a reference to the collection of elements contained by the object. + * The Document interface's read-only **`all`** property returns an HTMLAllCollection rooted at the document node. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/all) */ readonly all: HTMLAllCollection; /** - * Retrieves a collection of all a objects that have a name and/or id property. Objects in this collection are in HTML source order. + * The **`anchors`** read-only property of the An HTMLCollection. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/anchors) */ readonly anchors: HTMLCollectionOf; /** - * Retrieves a collection of all applet objects in the document. + * The **`applets`** property of the Document returns an empty HTMLCollection. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/applets) */ readonly applets: HTMLCollection; /** - * Deprecated. Sets or retrieves a value that indicates the background color behind the object. + * The deprecated `bgColor` property gets or sets the background color of the current document. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/bgColor) */ bgColor: string; /** - * Specifies the beginning and end of the document body. + * The **`Document.body`** property represents the `null` if no such element exists. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/body) */ body: HTMLElement; /** - * Returns document's encoding. + * The **`Document.characterSet`** read-only property returns the character encoding of the document that it's currently rendered with. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/characterSet) */ readonly characterSet: string; /** - * Gets or sets the character set used to encode the object. * @deprecated This is a legacy alias of `characterSet`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/characterSet) */ readonly charset: string; /** - * Gets a value that indicates whether standards-compliant mode is switched on for the object. + * The **`Document.compatMode`** read-only property indicates whether the document is rendered in Quirks mode or Standards mode. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/compatMode) */ readonly compatMode: string; /** - * Returns document's content type. + * The **`Document.contentType`** read-only property returns the MIME type that the document is being rendered as. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/contentType) */ readonly contentType: 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. + * The Document property `cookie` lets you read and write cookies associated with the document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/cookie) */ cookie: string; /** - * 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. + * The **`Document.currentScript`** property returns the script element whose script is currently being processed and isn't a JavaScript module. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/currentScript) */ readonly currentScript: HTMLOrSVGScriptElement | null; /** - * Returns the Window object of the active document. + * In browsers, **`document.defaultView`** returns the This property is read-only. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/defaultView) */ readonly defaultView: (WindowProxy & typeof globalThis) | null; /** - * Sets or gets a value that indicates whether the document can be edited. + * **`document.designMode`** controls whether the entire document is editable. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/designMode) */ designMode: string; /** - * Sets or retrieves a value that indicates the reading order of the object. + * The **`Document.dir`** property is a string representing the directionality of the text of the document, whether left to right (default) or right to left. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/dir) */ dir: string; /** - * Gets an object representing the document type declaration associated with the current document. + * The **`doctype`** read-only property of the Document interface is a DocumentType object representing the Doctype associated with the current document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/doctype) */ readonly doctype: DocumentType | null; /** - * Gets a reference to the root node of the document. + * The **`documentElement`** read-only property of the Document interface returns the example, the html element for HTML documents). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/documentElement) */ readonly documentElement: HTMLElement; /** - * Returns document's URL. + * The **`documentURI`** read-only property of the A string. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/documentURI) */ readonly documentURI: string; /** - * Sets or gets the security domain of the document. + * The **`domain`** property of the Document interface gets/sets the domain portion of the origin of the current document, as used by the same-origin policy. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/domain) */ domain: string; /** - * Retrieves a collection of all embed objects in the document. + * The **`embeds`** read-only property of the An HTMLCollection. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/embeds) */ readonly embeds: HTMLCollectionOf; /** - * Sets or gets the foreground (text) color of the document. + * **`fgColor`** gets/sets the foreground color, or text color, of the current document. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/fgColor) */ fgColor: string; /** - * Retrieves a collection, in source order, of all form objects in the document. + * The **`forms`** read-only property of the Document interface returns an HTMLCollection listing all the form elements contained in the document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/forms) */ readonly forms: HTMLCollectionOf; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/fragmentDirective) */ + /** + * The **`fragmentDirective`** read-only property of the Document interface returns the FragmentDirective for the current document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/fragmentDirective) + */ readonly fragmentDirective: FragmentDirective; /** + * The obsolete Document interface's **`fullscreen`** read-only property reports whether or not the document is currently displaying content in fullscreen mode. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/fullscreen) */ readonly fullscreen: boolean; /** - * Returns true if document has the ability to display elements fullscreen and fullscreen is supported, or false otherwise. + * The read-only **`fullscreenEnabled`** property on the Document interface indicates whether or not fullscreen mode is available. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/fullscreenEnabled) */ readonly fullscreenEnabled: boolean; /** - * Returns the head element. + * The **`head`** read-only property of the Document interface returns the head element of the current document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/head) */ readonly head: HTMLHeadElement; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/hidden) */ + /** + * The **`Document.hidden`** read-only property returns a Boolean value indicating if the page is considered hidden or not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/hidden) + */ readonly hidden: boolean; /** - * Retrieves a collection, in source order, of img objects in the document. + * The **`images`** read-only property of the Document interface returns a collection of the images in the current HTML document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/images) */ readonly images: HTMLCollectionOf; /** - * Gets the implementation object of the current document. + * The **`Document.implementation`** property returns a A DOMImplementation object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/implementation) */ readonly implementation: DOMImplementation; /** - * 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](https://developer.mozilla.org/docs/Web/API/Document/characterSet) */ readonly inputEncoding: string; /** - * Gets the date that the page was last modified, if the page supplies one. + * The **`lastModified`** property of the Document interface returns a string containing the date and local time on which the current document was last modified. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastModified) */ readonly lastModified: string; /** - * Sets or gets the color of the document links. + * The **`Document.linkColor`** property gets/sets the color of links within the document. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/linkColor) */ linkColor: string; /** - * Retrieves a collection of all a objects that specify the href property and all area objects in the document. + * The **`links`** read-only property of the Document interface returns a collection of all area elements and a elements in a document with a value for the href attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/links) */ readonly links: HTMLCollectionOf; /** - * Contains information about the current URL. + * The **`Document.location`** read-only property returns a and provides methods for changing that URL and loading another URL. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/location) */ @@ -8048,124 +9828,140 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve onpointerlockchange: ((this: Document, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/pointerlockerror_event) */ onpointerlockerror: ((this: Document, ev: Event) => any) | null; - /** - * Fires when the state of the object has changed. - * @param ev The event - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/readystatechange_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/readystatechange_event) */ onreadystatechange: ((this: Document, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/visibilitychange_event) */ onvisibilitychange: ((this: Document, ev: Event) => any) | null; readonly ownerDocument: null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/pictureInPictureEnabled) */ + /** + * The read-only **`pictureInPictureEnabled`** property of the available. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/pictureInPictureEnabled) + */ readonly pictureInPictureEnabled: boolean; /** - * Return an HTMLCollection of the embed elements in the Document. + * The **`plugins`** read-only property of the containing one or more HTMLEmbedElements representing the An HTMLCollection. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/plugins) */ readonly plugins: HTMLCollectionOf; /** - * Retrieves a value that indicates the current state of the object. + * The **`Document.readyState`** property describes the loading state of the document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/readyState) */ readonly readyState: DocumentReadyState; /** - * Gets the URL of the location that referred the user to the current page. + * The **`Document.referrer`** property returns the URI of the page that linked to this page. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/referrer) */ readonly referrer: string; /** + * **`Document.rootElement`** returns the Element that is the root element of the document if it is an documents. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/rootElement) */ readonly rootElement: SVGSVGElement | null; /** - * Retrieves a collection of all script objects in the document. + * The **`scripts`** property of the Document interface returns a list of the script elements in the document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scripts) */ readonly scripts: HTMLCollectionOf; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollingElement) */ + /** + * The **`scrollingElement`** read-only property of the scrolls the document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollingElement) + */ readonly scrollingElement: Element | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/timeline) */ + /** + * The `timeline` readonly property of the Document interface represents the default timeline of the current document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/timeline) + */ readonly timeline: DocumentTimeline; /** - * Contains the title of the document. + * The **`document.title`** property gets or sets the current title of the document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/title) */ title: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/visibilityState) */ + /** + * The **`Document.visibilityState`** read-only property returns the visibility of the document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/visibilityState) + */ readonly visibilityState: DocumentVisibilityState; /** - * Sets or gets the color of the links that the user has visited. + * The **`Document.vlinkColor`** property gets/sets the color of links that the user has visited in the document. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/vlinkColor) */ vlinkColor: string; /** - * 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. + * **`Document.adoptNode()`** transfers a node/dom from another Document into the method's document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/adoptNode) */ adoptNode(node: T): T; /** @deprecated */ captureEvents(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/caretPositionFromPoint) */ + /** + * The **`caretPositionFromPoint()`** method of the Document interface returns a CaretPosition object, containing the DOM node, along with the caret and caret's character offset within that node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/caretPositionFromPoint) + */ caretPositionFromPoint(x: number, y: number, options?: CaretPositionFromPointOptions): CaretPosition | null; /** @deprecated */ caretRangeFromPoint(x: number, y: number): Range | null; /** + * The **`Document.clear()`** method does nothing, but doesn't raise any error. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/clear) */ clear(): void; /** - * Closes an output stream and forces the sent data to display. + * The **`Document.close()`** method finishes writing to a document, opened with Document.open(). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/close) */ close(): void; /** - * Creates an attribute object with a specified name. - * @param name String that sets the attribute object's name. + * The **`Document.createAttribute()`** method creates a new attribute node, and returns it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createAttribute) */ createAttribute(localName: string): Attr; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createAttributeNS) */ + /** + * The **`Document.createAttributeNS()`** method creates a new attribute node with the specified namespace URI and qualified name, and returns it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createAttributeNS) + */ createAttributeNS(namespace: string | null, qualifiedName: string): Attr; /** - * Returns a CDATASection node whose data is data. + * **`createCDATASection()`** creates a new CDATA section node, and returns it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createCDATASection) */ createCDATASection(data: string): CDATASection; /** - * Creates a comment object with the specified data. - * @param data Sets the comment object's data. + * **`createComment()`** creates a new comment node, and returns it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createComment) */ createComment(data: string): Comment; /** - * Creates a new document. + * Creates a new empty DocumentFragment into which DOM nodes can be added to build an offscreen DOM tree. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createDocumentFragment) */ createDocumentFragment(): DocumentFragment; /** - * Creates an instance of the element for the specified tag. - * @param tagName The name of an element. + * In an HTML document, the **`document.createElement()`** method creates the HTML element specified by `localName`, or an HTMLUnknownElement if `localName` isn't recognized. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createElement) */ @@ -8174,19 +9970,7 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve createElement(tagName: K, options?: ElementCreationOptions): HTMLElementDeprecatedTagNameMap[K]; createElement(tagName: string, options?: ElementCreationOptions): 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. + * Creates an element with the specified namespace URI and qualified name. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createElementNS) */ @@ -8198,6 +9982,7 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve createElementNS(namespaceURI: string | null, qualifiedName: string, options?: ElementCreationOptions): Element; createElementNS(namespace: string | null, qualifiedName: string, options?: string | ElementCreationOptions): Element; /** + * Creates an event of the type specified. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createEvent) @@ -8269,83 +10054,75 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve createEvent(eventInterface: "WheelEvent"): WheelEvent; createEvent(eventInterface: string): Event; /** - * 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. + * The **`Document.createNodeIterator()`** method returns a new `NodeIterator` object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createNodeIterator) */ createNodeIterator(root: Node, whatToShow?: number, filter?: NodeFilter | null): NodeIterator; /** - * 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. + * `createProcessingInstruction()` generates a new processing instruction node and returns it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createProcessingInstruction) */ createProcessingInstruction(target: string, data: string): ProcessingInstruction; /** - * Returns an empty range object that has both of its boundary points positioned at the beginning of the document. + * The **`Document.createRange()`** method returns a new ```js-nolint createRange() ``` None. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createRange) */ createRange(): Range; /** - * Creates a text string from the specified value. - * @param data String that specifies the nodeValue property of the text node. + * Creates a new Text node. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createTextNode) */ createTextNode(data: string): Text; /** - * 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. + * The **`Document.createTreeWalker()`** creator method returns a newly created TreeWalker object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/createTreeWalker) */ createTreeWalker(root: Node, whatToShow?: number, filter?: NodeFilter | null): TreeWalker; /** - * Executes a command on the current document, current selection, or the given range. - * @param commandId String that specifies the command to execute. This command can be any of the command identifiers that can be executed in script. - * @param showUI Display the user interface, defaults to false. - * @param value Value to assign. + * The **`execCommand`** method implements multiple different commands. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/execCommand) */ execCommand(commandId: string, showUI?: boolean, value?: string): boolean; /** - * Stops document's fullscreen element from being displayed fullscreen and resolves promise when done. + * The Document method **`exitFullscreen()`** requests that the element on this document which is currently being presented in fullscreen mode be taken out of fullscreen mode, restoring the previous state of the screen. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/exitFullscreen) */ exitFullscreen(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/exitPictureInPicture) */ + /** + * The **`exitPictureInPicture()`** method of the Document interface requests that a video contained in this document, which is currently floating, be taken out of picture-in-picture mode, restoring the previous state of the screen. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/exitPictureInPicture) + */ exitPictureInPicture(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/exitPointerLock) */ - exitPointerLock(): void; /** - * Returns a reference to the first object with the specified value of the ID attribute. - * @param elementId String that specifies the ID value. + * The **`exitPointerLock()`** method of the Document interface asynchronously releases a pointer lock previously requested through Element.requestPointerLock. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/exitPointerLock) */ + exitPointerLock(): void; getElementById(elementId: string): HTMLElement | null; /** - * 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. + * The **`getElementsByClassName`** method of of all child elements which have all of the given class name(s). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/getElementsByClassName) */ getElementsByClassName(classNames: string): HTMLCollectionOf; /** - * 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. + * The **`getElementsByName()`** method of the Document object returns a NodeList Collection of elements with a given `name` attribute in the document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/getElementsByName) */ getElementsByName(elementName: string): NodeListOf; /** - * Retrieves a collection of objects based on the specified element name. - * @param name Specifies the name of an element. + * The **`getElementsByTagName`** method of The complete document is searched, including the root node. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/getElementsByTagName) */ @@ -8356,13 +10133,7 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: string): HTMLCollectionOf; /** - * 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. + * Returns a list of elements with the given tag name belonging to the given namespace. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/getElementsByTagNameNS) */ @@ -8371,91 +10142,84 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf; /** - * Returns an object representing the current selection of the document that is loaded into the object displaying a webpage. + * The **`getSelection()`** method of the Document interface returns the Selection object associated with this document, representing the range of text selected by the user, or the current position of the caret. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/getSelection) */ getSelection(): Selection | null; /** - * Gets a value indicating whether the object currently has focus. + * The **`hasFocus()`** method of the Document interface returns a boolean value indicating whether the document or any element inside the document has focus. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/hasFocus) */ hasFocus(): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/hasStorageAccess) */ - hasStorageAccess(): Promise; /** - * Returns a copy of node. If deep is true, the copy also includes the node's descendants. + * The **`hasStorageAccess()`** method of the Document interface returns a Promise that resolves with a boolean value indicating whether the document has access to third-party, unpartitioned cookies. * - * If node is a document or a shadow root, throws a "NotSupportedError" DOMException. + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/hasStorageAccess) + */ + hasStorageAccess(): Promise; + /** + * The Document object's **`importNode()`** method creates a copy of a inserted into the current document later. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/importNode) */ importNode(node: T, options?: boolean | ImportNodeOptions): T; /** - * 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. + * The **`Document.open()`** method opens a document for This does come with some side effects. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/open) */ open(unused1?: string, unused2?: string): Document; open(url: string | URL, name: string, features: string): WindowProxy | null; /** - * Returns a Boolean value that indicates whether a specified command can be successfully executed using execCommand, given the current state of the document. - * @param commandId Specifies a command identifier. + * The **`Document.queryCommandEnabled()`** method reports whether or not the specified editor command is enabled by the browser. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/queryCommandEnabled) */ queryCommandEnabled(commandId: string): boolean; - /** - * Returns a Boolean value that indicates whether the specified command is in the indeterminate state. - * @param commandId String that specifies a command identifier. - * @deprecated - */ + /** @deprecated */ queryCommandIndeterm(commandId: string): boolean; /** - * Returns a Boolean value that indicates the current state of the command. - * @param commandId String that specifies a command identifier. + * The **`queryCommandState()`** method will tell you if the current selection has a certain Document.execCommand() command applied. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/queryCommandState) */ queryCommandState(commandId: string): boolean; /** - * Returns a Boolean value that indicates whether the current command is supported on the current range. - * @param commandId Specifies a command identifier. + * The **`Document.queryCommandSupported()`** method reports whether or not the specified editor command is supported by the browser. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/queryCommandSupported) */ queryCommandSupported(commandId: string): boolean; - /** - * Returns the current value of the document, range, or current selection for the given command. - * @param commandId String that specifies a command identifier. - * @deprecated - */ + /** @deprecated */ queryCommandValue(commandId: string): string; /** @deprecated */ releaseEvents(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/requestStorageAccess) */ + /** + * The **`requestStorageAccess()`** method of the Document interface allows content loaded in a third-party context (i.e., embedded in an iframe) to request access to third-party cookies and unpartitioned state. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/requestStorageAccess) + */ requestStorageAccess(): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/startViewTransition) */ + /** + * The **`startViewTransition()`** method of the Document interface starts a new same-document (SPA) view transition and returns a ViewTransition object to represent it. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/startViewTransition) + */ startViewTransition(callbackOptions?: ViewTransitionUpdateCallback | StartViewTransitionOptions): ViewTransition; /** - * Writes one or more HTML expressions to a document in the specified window. - * @param content Specifies the text and HTML tags to write. + * The **`document.write()`** method writes a string of text to a document stream opened by document.open(). * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/write) */ write(...text: string[]): void; /** - * 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. + * Writes a string of text followed by a newline character to a document. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/writeln) */ @@ -8511,17 +10275,8 @@ interface DocumentOrShadowRoot { readonly pictureInPictureElement: Element | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/pointerLockElement) */ readonly pointerLockElement: Element | null; - /** - * 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](https://developer.mozilla.org/docs/Web/API/Document/styleSheets) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/styleSheets) */ readonly styleSheets: StyleSheetList; - /** - * Returns the element for the specified x coordinate and the specified y coordinate. - * @param x The x-offset - * @param y The y-offset - */ elementFromPoint(x: number, y: number): Element | null; elementsFromPoint(x: number, y: number): Element[]; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/getAnimations) */ @@ -8547,12 +10302,24 @@ declare var DocumentTimeline: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType) */ interface DocumentType extends Node, ChildNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType/name) */ + /** + * The read-only **`name`** property of the DocumentType returns the type of the document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType/name) + */ readonly name: string; readonly ownerDocument: Document; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType/publicId) */ + /** + * The read-only **`publicId`** property of the DocumentType returns a formal identifier of the document. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType/publicId) + */ readonly publicId: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType/systemId) */ + /** + * The read-only **`systemId`** property of the DocumentType returns the URL of the associated DTD. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DocumentType/systemId) + */ readonly systemId: string; } @@ -8568,7 +10335,7 @@ declare var DocumentType: { */ interface DragEvent extends MouseEvent { /** - * Returns the DataTransfer object for the event. + * The **`DragEvent.dataTransfer`** read-only property holds the drag operation's data (as a DataTransfer object). * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DragEvent/dataTransfer) */ @@ -8586,17 +10353,41 @@ declare var DragEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode) */ interface DynamicsCompressorNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/attack) */ + /** + * The `attack` property of the DynamicsCompressorNode interface is a k-rate AudioParam representing the amount of time, in seconds, required to reduce the gain by 10 dB. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/attack) + */ readonly attack: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/knee) */ + /** + * The `knee` property of the DynamicsCompressorNode interface is a k-rate AudioParam containing a decibel value representing the range above the threshold where the curve smoothly transitions to the compressed portion. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/knee) + */ readonly knee: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/ratio) */ + /** + * The `ratio` property of the DynamicsCompressorNode interface Is a k-rate AudioParam representing the amount of change, in dB, needed in the input for a 1 dB change in the output. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/ratio) + */ readonly ratio: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/reduction) */ + /** + * The **`reduction`** read-only property of the DynamicsCompressorNode interface is a float representing the amount of gain reduction currently applied by the compressor to the signal. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/reduction) + */ readonly reduction: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/release) */ + /** + * The `release` property of the DynamicsCompressorNode interface Is a k-rate AudioParam representing the amount of time, in seconds, required to increase the gain by 10 dB. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/release) + */ readonly release: AudioParam; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/threshold) */ + /** + * The `threshold` property of the DynamicsCompressorNode interface is a k-rate AudioParam representing the decibel value above which the compression will start taking effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DynamicsCompressorNode/threshold) + */ readonly threshold: AudioParam; } @@ -8732,47 +10523,75 @@ interface ElementEventMap { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element) */ interface Element extends Node, ARIAMixin, Animatable, ChildNode, NonDocumentTypeChildNode, ParentNode, Slottable { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes) */ + /** + * The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes) + */ readonly attributes: NamedNodeMap; /** - * Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object. + * The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList) */ get classList(): DOMTokenList; set classList(value: string); /** - * Returns the value of element's class content attribute. Can be set to change it. + * The **`className`** property of the of the specified element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className) */ className: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight) */ + /** + * The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight) + */ readonly clientHeight: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft) */ + /** + * The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft) + */ readonly clientLeft: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop) */ + /** + * The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop) + */ readonly clientTop: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth) */ + /** + * The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth) + */ readonly clientWidth: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom) */ + /** + * The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom) + */ readonly currentCSSZoom: number; /** - * Returns the value of element's id content attribute. Can be set to change it. + * The **`id`** property of the Element interface represents the element's identifier, reflecting the **`id`** global attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id) */ id: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML) */ + /** + * The Element property **`innerHTML`** gets or sets the HTML or XML markup contained within the element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML) + */ innerHTML: string; /** - * Returns the local name. + * The **`Element.localName`** read-only property returns the local part of the qualified name of an element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName) */ readonly localName: string; /** - * Returns the namespace. + * The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI) */ @@ -8781,54 +10600,82 @@ interface Element extends Node, ARIAMixin, Animatable, ChildNode, NonDocumentTyp onfullscreenchange: ((this: Element, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event) */ onfullscreenerror: ((this: Element, ev: Event) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML) */ + /** + * The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML) + */ outerHTML: string; readonly ownerDocument: Document; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part) */ + /** + * The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part) + */ get part(): DOMTokenList; set part(value: string); /** - * Returns the namespace prefix. + * The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix) */ readonly prefix: string | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight) */ + /** + * The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight) + */ readonly scrollHeight: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft) */ + /** + * The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft) + */ scrollLeft: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop) */ + /** + * The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop) + */ scrollTop: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth) */ + /** + * The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth) + */ readonly scrollWidth: number; /** - * Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. + * The `Element.shadowRoot` read-only property represents the shadow root hosted by the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot) */ readonly shadowRoot: ShadowRoot | null; /** - * Returns the value of element's slot content attribute. Can be set to change it. + * The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot) */ slot: string; /** - * Returns the HTML-uppercased qualified name. + * The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName) */ readonly tagName: string; /** - * Creates a shadow root for element and returns it. + * The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow) */ attachShadow(init: ShadowRootInit): ShadowRoot; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility) */ + /** + * The **`checkVisibility()`** method of the Element interface checks whether the element is visible. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility) + */ checkVisibility(options?: CheckVisibilityOptions): boolean; /** - * Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. + * The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest) */ @@ -8836,147 +10683,235 @@ interface Element extends Node, ARIAMixin, Animatable, ChildNode, NonDocumentTyp closest(selector: K): SVGElementTagNameMap[K] | null; closest(selector: K): MathMLElementTagNameMap[K] | null; closest(selectors: string): E | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap) */ + /** + * The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap) + */ computedStyleMap(): StylePropertyMapReadOnly; /** - * Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. + * The **`getAttribute()`** method of the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute) */ getAttribute(qualifiedName: string): string | null; /** - * Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. + * The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS) */ getAttributeNS(namespace: string | null, localName: string): string | null; /** - * Returns the qualified names of all element's attributes. Can contain duplicates. + * The **`getAttributeNames()`** method of the array. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames) */ getAttributeNames(): string[]; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode) */ + /** + * Returns the specified attribute of the specified element, as an Attr node. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode) + */ getAttributeNode(qualifiedName: string): Attr | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS) */ + /** + * The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS) + */ getAttributeNodeNS(namespace: string | null, localName: string): Attr | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect) */ + /** + * The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect) + */ getBoundingClientRect(): DOMRect; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects) */ + /** + * The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects) + */ getClientRects(): DOMRectList; /** - * 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. + * The Element method **`getElementsByClassName()`** returns a live specified class name or names. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName) */ getElementsByClassName(classNames: string): HTMLCollectionOf; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName) */ + /** + * The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName) + */ getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: K): HTMLCollectionOf; /** @deprecated */ getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: string): HTMLCollectionOf; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS) */ + /** + * The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS) + */ getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML) */ - getHTML(options?: GetHTMLOptions): string; /** - * Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. + * The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string. * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute) + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML) + */ + getHTML(options?: GetHTMLOptions): string; + /** + * The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute) */ hasAttribute(qualifiedName: string): boolean; /** - * Returns true if element has an attribute whose namespace is namespace and local name is localName. + * The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS) */ hasAttributeNS(namespace: string | null, localName: string): boolean; /** - * Returns true if element has attributes, and false otherwise. + * The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes) */ hasAttributes(): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture) */ + /** + * The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture) + */ hasPointerCapture(pointerId: number): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement) */ + /** + * The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement) + */ insertAdjacentElement(where: InsertPosition, element: Element): Element | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML) */ + /** + * The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML) + */ insertAdjacentHTML(position: InsertPosition, string: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText) */ + /** + * The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText) + */ insertAdjacentText(where: InsertPosition, data: string): void; /** - * Returns true if matching selectors against element's root yields element, and false otherwise. + * The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches) */ matches(selectors: string): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture) */ + /** + * The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture) + */ releasePointerCapture(pointerId: number): void; /** - * Removes element's first attribute whose qualified name is qualifiedName. + * The Element method **`removeAttribute()`** removes the attribute with the specified name from the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute) */ removeAttribute(qualifiedName: string): void; /** - * Removes element's attribute whose namespace is namespace and local name is localName. + * The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS) */ removeAttributeNS(namespace: string | null, localName: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode) */ - removeAttributeNode(attr: Attr): Attr; /** - * Displays element fullscreen and resolves promise when done. + * The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element. * - * When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference. + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode) + */ + removeAttributeNode(attr: Attr): Attr; + /** + * The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen) */ requestFullscreen(options?: FullscreenOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock) */ + /** + * The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock) + */ requestPointerLock(options?: PointerLockOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll) */ + /** + * The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll) + */ scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy) */ + /** + * The **`scrollBy()`** method of the Element interface scrolls an element by the given amount. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy) + */ scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView) */ + /** + * The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView) + */ scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo) */ + /** + * The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo) + */ scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; /** - * Sets the value of element's first attribute whose qualified name is qualifiedName to value. + * The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute) */ setAttribute(qualifiedName: string, value: string): void; /** - * Sets the value of element's attribute whose namespace is namespace and local name is localName to value. + * `setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS) */ setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode) */ + /** + * The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode) + */ setAttributeNode(attr: Attr): Attr | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS) */ + /** + * The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS) + */ setAttributeNodeNS(attr: Attr): Attr | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe) */ + /** + * The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, which then replaces the element's subtree in the DOM. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe) + */ setHTMLUnsafe(html: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture) */ - setPointerCapture(pointerId: number): void; /** - * If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. + * The **`setPointerCapture()`** method of the _capture target_ of future pointer events. * - * Returns true if qualifiedName is now present, and false otherwise. + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture) + */ + setPointerCapture(pointerId: number): void; + /** + * The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute) */ @@ -9024,65 +10959,67 @@ interface ElementContentEditable { */ interface ElementInternals extends ARIAMixin { /** - * Returns the form owner of internals's target element. + * The **`form`** read-only property of the ElementInternals interface returns the HTMLFormElement associated with this element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/form) */ readonly form: HTMLFormElement | null; /** - * Returns a NodeList of all the label elements that internals's target element is associated with. + * The **`labels`** read-only property of the ElementInternals interface returns the labels associated with the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/labels) */ readonly labels: NodeList; /** - * Returns the ShadowRoot for internals's target element, if the target element is a shadow host, or null otherwise. + * The **`shadowRoot`** read-only property of the ElementInternals interface returns the ShadowRoot for this element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/shadowRoot) */ readonly shadowRoot: ShadowRoot | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/states) */ + /** + * The **`states`** read-only property of the ElementInternals interface returns a CustomStateSet representing the possible states of the custom element. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/states) + */ readonly states: CustomStateSet; /** - * Returns the error message that would be shown to the user if internals's target element was to be checked for validity. + * The **`validationMessage`** read-only property of the ElementInternals interface returns the validation message for the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/validationMessage) */ readonly validationMessage: string; /** - * Returns the ValidityState object for internals's target element. + * The **`validity`** read-only property of the ElementInternals interface returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/validity) */ readonly validity: ValidityState; /** - * Returns true if internals's target element will be validated when the form is submitted; false otherwise. + * The **`willValidate`** read-only property of the ElementInternals interface returns `true` if the element is a submittable element that is a candidate for constraint validation. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/willValidate) */ readonly willValidate: boolean; /** - * Returns true if internals's target element has no validity problems; false otherwise. Fires an invalid event at the element in the latter case. + * The **`checkValidity()`** method of the ElementInternals interface checks if the element meets any constraint validation rules applied to it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/checkValidity) */ checkValidity(): boolean; /** - * Returns true if internals's target element has no validity problems; otherwise, returns false, fires an invalid event at the element, and (if the event isn't canceled) reports the problem to the user. + * The **`reportValidity()`** method of the ElementInternals interface checks if the element meets any constraint validation rules applied to it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/reportValidity) */ reportValidity(): boolean; /** - * Sets both the state and submission value of internals's target element to value. - * - * If value is null, the element won't participate in form submission. + * The **`setFormValue()`** method of the ElementInternals interface sets the element's submission value and state, communicating these to the user agent. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/setFormValue) */ setFormValue(value: File | string | FormData | null, state?: File | string | FormData | null): void; /** - * Marks internals's target element as suffering from the constraints indicated by the flags argument, and sets the element's validation message to message. If anchor is specified, the user agent might use it to indicate problems with the constraints of internals's target element when the form owner is validated interactively or reportValidity() is called. + * The **`setValidity()`** method of the ElementInternals interface sets the validity of the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ElementInternals/setValidity) */ @@ -9100,15 +11037,35 @@ declare var ElementInternals: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk) */ interface EncodedAudioChunk { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/byteLength) */ + /** + * The **`byteLength`** read-only property of the EncodedAudioChunk interface returns the length in bytes of the encoded audio data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/byteLength) + */ readonly byteLength: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/duration) */ + /** + * The **`duration`** read-only property of the EncodedAudioChunk interface returns an integer indicating the duration of the audio in microseconds. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/duration) + */ readonly duration: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/timestamp) */ + /** + * The **`timestamp`** read-only property of the EncodedAudioChunk interface returns an integer indicating the timestamp of the audio in microseconds. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/timestamp) + */ readonly timestamp: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/type) */ + /** + * The **`type`** read-only property of the EncodedAudioChunk interface returns a value indicating whether the audio chunk is a key chunk, which does not relying on other frames for decoding. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/type) + */ readonly type: EncodedAudioChunkType; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/copyTo) */ + /** + * The **`copyTo()`** method of the EncodedAudioChunk interface copies the encoded chunk of audio data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedAudioChunk/copyTo) + */ copyTo(destination: AllowSharedBufferSource): void; } @@ -9123,15 +11080,35 @@ declare var EncodedAudioChunk: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk) */ interface EncodedVideoChunk { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/byteLength) */ + /** + * The **`byteLength`** read-only property of the EncodedVideoChunk interface returns the length in bytes of the encoded video data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/byteLength) + */ readonly byteLength: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/duration) */ + /** + * The **`duration`** read-only property of the EncodedVideoChunk interface returns an integer indicating the duration of the video in microseconds. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/duration) + */ readonly duration: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/timestamp) */ + /** + * The **`timestamp`** read-only property of the EncodedVideoChunk interface returns an integer indicating the timestamp of the video in microseconds. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/timestamp) + */ readonly timestamp: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/type) */ + /** + * The **`type`** read-only property of the EncodedVideoChunk interface returns a value indicating whether the video chunk is a key chunk, which does not rely on other frames for decoding. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/type) + */ readonly type: EncodedVideoChunkType; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/copyTo) */ + /** + * The **`copyTo()`** method of the EncodedVideoChunk interface copies the encoded chunk of video data. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/copyTo) + */ copyTo(destination: AllowSharedBufferSource): void; } @@ -9146,15 +11123,35 @@ declare var EncodedVideoChunk: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent) */ interface ErrorEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno) */ + /** + * The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno) + */ readonly colno: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/error) */ + /** + * The **`error`** read-only property of the ErrorEvent interface returns a JavaScript value, such as an Error or DOMException, representing the error associated with this event. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/error) + */ readonly error: any; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename) */ + /** + * The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename) + */ readonly filename: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno) */ + /** + * The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno) + */ readonly lineno: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message) */ + /** + * The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message) + */ readonly message: string; } @@ -9170,109 +11167,113 @@ declare var ErrorEvent: { */ interface Event { /** - * Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise. + * The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles) */ readonly bubbles: boolean; /** + * The **`cancelBubble`** property of the Event interface is deprecated. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble) */ cancelBubble: boolean; /** - * Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method. + * The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable) */ readonly cancelable: boolean; /** - * Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise. + * The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed) */ readonly composed: boolean; /** - * Returns the object whose event listener's callback is currently being invoked. + * The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget) */ readonly currentTarget: EventTarget | null; /** - * Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. + * The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented) */ readonly defaultPrevented: boolean; /** - * Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. + * The **`eventPhase`** read-only property of the being evaluated. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase) */ readonly eventPhase: number; /** - * Returns true if event was dispatched by the user agent, and false otherwise. + * The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted) */ readonly isTrusted: boolean; /** + * The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue) */ returnValue: boolean; /** + * The deprecated **`Event.srcElement`** is an alias for the Event.target property. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement) */ readonly srcElement: EventTarget | null; /** - * Returns the object to which event is dispatched (its target). + * The read-only **`target`** property of the dispatched. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target) */ readonly target: EventTarget | null; /** - * Returns the event's timestamp as the number of milliseconds measured relative to the time origin. + * The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp) */ readonly timeStamp: DOMHighResTimeStamp; /** - * Returns the type of event, e.g. "click", "hashchange", or "submit". + * The **`type`** read-only property of the Event interface returns a string containing the event's type. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type) */ readonly type: string; /** - * Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget. + * The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath) */ composedPath(): EventTarget[]; /** + * The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent(). * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent) */ initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void; /** - * If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled. + * The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault) */ preventDefault(): void; /** - * Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects. + * The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation) */ stopImmediatePropagation(): void; /** - * When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object. + * The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation) */ @@ -9333,25 +11334,25 @@ interface EventSource extends EventTarget { /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/open_event) */ onopen: ((this: EventSource, ev: Event) => any) | null; /** - * Returns the state of this EventSource object's connection. It can have the values described below. + * The **`readyState`** read-only property of the connection. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/readyState) */ readonly readyState: number; /** - * Returns the URL providing the event stream. + * The **`url`** read-only property of the URL of the source. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/url) */ readonly url: string; /** - * Returns true if the credentials mode for connection requests to the URL providing the event stream is set to "include", and false otherwise. + * The **`withCredentials`** read-only property of the the `EventSource` object was instantiated with CORS credentials set. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/withCredentials) */ readonly withCredentials: boolean; /** - * Aborts any instances of the fetch algorithm started for this EventSource object, and sets the readyState attribute to CLOSED. + * The **`close()`** method of the EventSource interface closes the connection, if one is made, and sets the ```js-nolint close() ``` None. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/close) */ @@ -9382,31 +11383,19 @@ declare var EventSource: { */ interface EventTarget { /** - * 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. + * The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener) */ addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: AddEventListenerOptions | boolean): void; /** - * 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. + * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) */ dispatchEvent(event: Event): boolean; /** - * Removes the event listener in target's event listener list with the same type, callback, and options. + * The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener) */ @@ -9438,11 +11427,23 @@ declare var External: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File) */ interface File extends Blob { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */ + /** + * The **`lastModified`** read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) + */ readonly lastModified: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */ + /** + * The **`name`** read-only property of the File interface returns the name of the file represented by a File object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/webkitRelativePath) */ + /** + * The **`webkitRelativePath`** read-only property of the File interface contains a string which specifies the file's path relative to the directory selected by the user in an input element with its `webkitdirectory` attribute set. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/webkitRelativePath) + */ readonly webkitRelativePath: string; } @@ -9457,9 +11458,17 @@ declare var File: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileList) */ interface FileList { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileList/length) */ + /** + * The **`length`** read-only property of the FileList interface returns the number of files in the `FileList`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileList/length) + */ readonly length: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileList/item) */ + /** + * The **`item()`** method of the FileList interface returns a File object representing the file at the specified index in the file list. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileList/item) + */ item(index: number): File | null; [index: number]: File; } @@ -9484,7 +11493,11 @@ interface FileReaderEventMap { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader) */ interface FileReader extends EventTarget { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/error) */ + /** + * The **`error`** read-only property of the FileReader interface returns the error that occurred while reading the file. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/error) + */ readonly error: DOMException | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/abort_event) */ onabort: ((this: FileReader, ev: ProgressEvent) => any) | null; @@ -9498,23 +11511,48 @@ interface FileReader extends EventTarget { onloadstart: ((this: FileReader, ev: ProgressEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/progress_event) */ onprogress: ((this: FileReader, ev: ProgressEvent) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readyState) */ + /** + * The **`readyState`** read-only property of the FileReader interface provides the current state of the reading operation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readyState) + */ readonly readyState: typeof FileReader.EMPTY | typeof FileReader.LOADING | typeof FileReader.DONE; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/result) */ + /** + * The **`result`** read-only property of the FileReader interface returns the file's contents. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/result) + */ readonly result: string | ArrayBuffer | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/abort) */ + /** + * The **`abort()`** method of the FileReader interface aborts the read operation. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/abort) + */ abort(): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsArrayBuffer) */ + /** + * The **`readAsArrayBuffer()`** method of the FileReader interface is used to start reading the contents of a specified Blob or File. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsArrayBuffer) + */ readAsArrayBuffer(blob: Blob): void; /** + * The **`readAsBinaryString()`** method of the FileReader interface is used to start reading the contents of the specified Blob or File. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsBinaryString) */ readAsBinaryString(blob: Blob): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsDataURL) */ + /** + * The **`readAsDataURL()`** method of the FileReader interface is used to read the contents of the specified file's data as a base64 encoded string. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsDataURL) + */ readAsDataURL(blob: Blob): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsText) */ + /** + * The **`readAsText()`** method of the FileReader interface is used to read the contents of the specified Blob or File. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileReader/readAsText) + */ readAsText(blob: Blob, encoding?: string): void; readonly EMPTY: 0; readonly LOADING: 1; @@ -9539,9 +11577,17 @@ declare var FileReader: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystem) */ interface FileSystem { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystem/name) */ + /** + * The read-only **`name`** property of the string is unique among all file systems currently exposed by the File and Directory Entries API. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystem/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystem/root) */ + /** + * The read-only **`root`** property of the object representing the root directory of the file system, for use with the File and Directory Entries API. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystem/root) + */ readonly root: FileSystemDirectoryEntry; } @@ -9556,11 +11602,23 @@ declare var FileSystem: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry) */ interface FileSystemDirectoryEntry extends FileSystemEntry { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry/createReader) */ + /** + * The FileSystemDirectoryEntry interface's method **`createReader()`** returns a the directory. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry/createReader) + */ createReader(): FileSystemDirectoryReader; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry/getDirectory) */ + /** + * The FileSystemDirectoryEntry interface's method **`getDirectory()`** returns a somewhere within the directory subtree rooted at the directory on which it's called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry/getDirectory) + */ getDirectory(path?: string | null, options?: FileSystemFlags, successCallback?: FileSystemEntryCallback, errorCallback?: ErrorCallback): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry/getFile) */ + /** + * The FileSystemDirectoryEntry interface's method **`getFile()`** returns a within the directory subtree rooted at the directory on which it's called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryEntry/getFile) + */ getFile(path?: string | null, options?: FileSystemFlags, successCallback?: FileSystemEntryCallback, errorCallback?: ErrorCallback): void; } @@ -9577,13 +11635,29 @@ declare var FileSystemDirectoryEntry: { */ interface FileSystemDirectoryHandle extends FileSystemHandle { readonly kind: "directory"; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/getDirectoryHandle) */ + /** + * The **`getDirectoryHandle()`** method of the within the directory handle on which the method is called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/getDirectoryHandle) + */ getDirectoryHandle(name: string, options?: FileSystemGetDirectoryOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/getFileHandle) */ + /** + * The **`getFileHandle()`** method of the directory the method is called. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/getFileHandle) + */ getFileHandle(name: string, options?: FileSystemGetFileOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/removeEntry) */ + /** + * The **`removeEntry()`** method of the directory handle contains a file or directory called the name specified. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/removeEntry) + */ removeEntry(name: string, options?: FileSystemRemoveOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/resolve) */ + /** + * The **`resolve()`** method of the directory names from the parent handle to the specified child entry, with the name of the child entry as the last array item. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/resolve) + */ resolve(possibleDescendant: FileSystemHandle): Promise; } @@ -9598,7 +11672,11 @@ declare var FileSystemDirectoryHandle: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryReader) */ interface FileSystemDirectoryReader { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryReader/readEntries) */ + /** + * The FileSystemDirectoryReader interface's **`readEntries()`** method retrieves the directory entries within the directory being read and delivers them in an array to a provided callback function. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryReader/readEntries) + */ readEntries(successCallback: FileSystemEntriesCallback, errorCallback?: ErrorCallback): void; } @@ -9613,17 +11691,41 @@ declare var FileSystemDirectoryReader: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry) */ interface FileSystemEntry { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/filesystem) */ + /** + * The read-only **`filesystem`** property of the FileSystemEntry interface contains a resides. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/filesystem) + */ readonly filesystem: FileSystem; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/fullPath) */ + /** + * The read-only **`fullPath`** property of the FileSystemEntry interface returns a string specifying the full, absolute path from the file system's root to the file represented by the entry. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/fullPath) + */ readonly fullPath: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/isDirectory) */ + /** + * The read-only **`isDirectory`** property of the FileSystemEntry interface is `true` if the entry represents a directory (meaning it's a FileSystemDirectoryEntry) and `false` if it's not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/isDirectory) + */ readonly isDirectory: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/isFile) */ + /** + * The read-only **`isFile`** property of the FileSystemEntry interface is `true` if the entry represents a file (meaning it's a FileSystemFileEntry) and `false` if it's not. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/isFile) + */ readonly isFile: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/name) */ + /** + * The read-only **`name`** property of the FileSystemEntry interface returns a string specifying the entry's name; this is the entry within its parent directory (the last component of the path as indicated by the FileSystemEntry.fullPath property). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/getParent) */ + /** + * The FileSystemEntry interface's method **`getParent()`** obtains a ```js-nolint getParent(successCallback, errorCallback) getParent(successCallback) ``` - `successCallback` - : A function which is called when the parent directory entry has been retrieved. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemEntry/getParent) + */ getParent(successCallback?: FileSystemEntryCallback, errorCallback?: ErrorCallback): void; } @@ -9638,7 +11740,11 @@ declare var FileSystemEntry: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileEntry) */ interface FileSystemFileEntry extends FileSystemEntry { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileEntry/file) */ + /** + * The FileSystemFileEntry interface's method **`file()`** returns a the directory entry. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileEntry/file) + */ file(successCallback: FileCallback, errorCallback?: ErrorCallback): void; } @@ -9655,9 +11761,17 @@ declare var FileSystemFileEntry: { */ interface FileSystemFileHandle extends FileSystemHandle { readonly kind: "file"; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle/createWritable) */ + /** + * The **`createWritable()`** method of the FileSystemFileHandle interface creates a FileSystemWritableFileStream that can be used to write to a file. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle/createWritable) + */ createWritable(options?: FileSystemCreateWritableOptions): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle/getFile) */ + /** + * The **`getFile()`** method of the If the file on disk changes or is removed after this method is called, the returned ```js-nolint getFile() ``` None. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle/getFile) + */ getFile(): Promise; } @@ -9673,11 +11787,23 @@ declare var FileSystemFileHandle: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle) */ interface FileSystemHandle { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/kind) */ + /** + * The **`kind`** read-only property of the `'file'` if the associated entry is a file or `'directory'`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/kind) + */ readonly kind: FileSystemHandleKind; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/name) */ + /** + * The **`name`** read-only property of the handle. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/name) + */ readonly name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/isSameEntry) */ + /** + * The **`isSameEntry()`** method of the ```js-nolint isSameEntry(fileSystemHandle) ``` - FileSystemHandle - : The `FileSystemHandle` to match against the handle on which the method is invoked. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/isSameEntry) + */ isSameEntry(other: FileSystemHandle): Promise; } @@ -9693,11 +11819,23 @@ declare var FileSystemHandle: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream) */ interface FileSystemWritableFileStream extends WritableStream { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/seek) */ + /** + * The **`seek()`** method of the FileSystemWritableFileStream interface updates the current file cursor offset to the position (in bytes) specified when calling the method. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/seek) + */ seek(position: number): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/truncate) */ + /** + * The **`truncate()`** method of the FileSystemWritableFileStream interface resizes the file associated with the stream to the specified size in bytes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/truncate) + */ truncate(size: number): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/write) */ + /** + * The **`write()`** method of the FileSystemWritableFileStream interface writes content into the file the method is called on, at the current file cursor offset. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/write) + */ write(data: FileSystemWriteChunkType): Promise; } @@ -9712,7 +11850,11 @@ declare var FileSystemWritableFileStream: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FocusEvent) */ interface FocusEvent extends UIEvent { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FocusEvent/relatedTarget) */ + /** + * The **`relatedTarget`** read-only property of the FocusEvent interface is the secondary target, depending on the type of event:
Event name target relatedTarget
Element/blur_event The EventTarget losing focus The EventTarget receiving focus (if any).
Element/focus_event The EventTarget receiving focus The EventTarget losing focus (if any)
Element/focusin_event The EventTarget receiving focus The EventTarget losing focus (if any)
Element/focusout_event The EventTarget losing focus The EventTarget receiving focus (if any)
Note that many elements can't have focus, which is a common reason for `relatedTarget` to be `null`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FocusEvent/relatedTarget) + */ readonly relatedTarget: EventTarget | null; } @@ -9727,32 +11869,84 @@ declare var FocusEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace) */ interface FontFace { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/ascentOverride) */ + /** + * The **`ascentOverride`** property of the FontFace interface returns and sets the ascent metric for the font, the height above the baseline that CSS uses to lay out line boxes in an inline formatting context. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/ascentOverride) + */ ascentOverride: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/descentOverride) */ + /** + * The **`descentOverride`** property of the FontFace interface returns and sets the value of the @font-face/descent-override descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/descentOverride) + */ descentOverride: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/display) */ + /** + * The **`display`** property of the FontFace interface determines how a font face is displayed based on whether and when it is downloaded and ready to use. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/display) + */ display: FontDisplay; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/family) */ + /** + * The **`FontFace.family`** property allows the author to get or set the font family of a FontFace object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/family) + */ family: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/featureSettings) */ + /** + * The **`featureSettings`** property of the FontFace interface retrieves or sets infrequently used font features that are not available from a font's variant properties. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/featureSettings) + */ featureSettings: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/lineGapOverride) */ + /** + * The **`lineGapOverride`** property of the FontFace interface returns and sets the value of the @font-face/line-gap-override descriptor. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/lineGapOverride) + */ lineGapOverride: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/loaded) */ + /** + * The **`loaded`** read-only property of the FontFace interface returns a Promise that resolves with the current `FontFace` object when the font specified in the object's constructor is done loading or rejects with a `SyntaxError`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/loaded) + */ readonly loaded: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/status) */ + /** + * The **`status`** read-only property of the FontFace interface returns an enumerated value indicating the status of the font, one of `'unloaded'`, `'loading'`, `'loaded'`, or `'error'`. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/status) + */ readonly status: FontFaceLoadStatus; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/stretch) */ + /** + * The **`stretch`** property of the FontFace interface retrieves or sets how the font stretches. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/stretch) + */ stretch: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/style) */ + /** + * The **`style`** property of the FontFace interface retrieves or sets the font's style. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/style) + */ style: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/unicodeRange) */ + /** + * The **`unicodeRange`** property of the FontFace interface retrieves or sets the range of unicode code points encompassing the font. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/unicodeRange) + */ unicodeRange: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/weight) */ - weight: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/load) */ - load(): Promise; + /** + * The **`weight`** property of the FontFace interface retrieves or sets the weight of the font. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/weight) + */ + weight: string; + /** + * The **`load()`** method of the FontFace interface requests and loads a font whose `source` was specified as a URL. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFace/load) + */ + load(): Promise; } declare var FontFace: { @@ -9778,13 +11972,29 @@ interface FontFaceSet extends EventTarget { onloadingdone: ((this: FontFaceSet, ev: FontFaceSetLoadEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/loadingerror_event) */ onloadingerror: ((this: FontFaceSet, ev: FontFaceSetLoadEvent) => any) | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/ready) */ + /** + * The `ready` read-only property of the FontFaceSet interface returns a Promise that resolves to the given FontFaceSet. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/ready) + */ readonly ready: Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/status) */ + /** + * The **`status`** read-only property of the FontFaceSet interface returns the loading state of the fonts in the set. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/status) + */ readonly status: FontFaceSetLoadStatus; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/check) */ + /** + * The `check()` method of the FontFaceSet returns `true` if you can render some text using the given font specification without attempting to use any fonts in this `FontFaceSet` that are not yet fully loaded. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/check) + */ check(font: string, text?: string): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/load) */ + /** + * The `load()` method of the FontFaceSet forces all the fonts given in parameters to be loaded. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSet/load) + */ load(font: string, text?: string): Promise; forEach(callbackfn: (value: FontFace, key: FontFace, parent: FontFaceSet) => void, thisArg?: any): void; addEventListener(type: K, listener: (this: FontFaceSet, ev: FontFaceSetEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; @@ -9804,7 +12014,11 @@ declare var FontFaceSet: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSetLoadEvent) */ interface FontFaceSetLoadEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSetLoadEvent/fontfaces) */ + /** + * The **`fontfaces`** read-only property of the An array of FontFace instance. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FontFaceSetLoadEvent/fontfaces) + */ readonly fontfaces: ReadonlyArray; } @@ -9824,19 +12038,43 @@ interface FontFaceSource { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData) */ interface FormData { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) */ + /** + * The **`append()`** method of the FormData interface appends a new value onto an existing key inside a `FormData` object, or adds the key if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) + */ append(name: string, value: string | Blob): void; append(name: string, value: string): void; append(name: string, blobValue: Blob, filename?: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/delete) */ + /** + * The **`delete()`** method of the FormData interface deletes a key and its value(s) from a `FormData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/delete) + */ delete(name: string): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/get) */ + /** + * The **`get()`** method of the FormData interface returns the first value associated with a given key from within a `FormData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/get) + */ get(name: string): FormDataEntryValue | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/getAll) */ + /** + * The **`getAll()`** method of the FormData interface returns all the values associated with a given key from within a `FormData` object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/getAll) + */ getAll(name: string): FormDataEntryValue[]; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/has) */ + /** + * The **`has()`** method of the FormData interface returns whether a `FormData` object contains a certain key. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/has) + */ has(name: string): boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) */ + /** + * The **`set()`** method of the FormData interface sets a new value for an existing key inside a `FormData` object, or adds the key/value if it does not already exist. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) + */ set(name: string, value: string | Blob): void; set(name: string, value: string): void; set(name: string, blobValue: Blob, filename?: string): void; @@ -9855,7 +12093,7 @@ declare var FormData: { */ interface FormDataEvent extends Event { /** - * Returns a FormData object representing names and values of elements associated to the target form. Operations on the FormData object will affect form data to be submitted. + * The `formData` read-only property of the FormDataEvent interface contains the FormData object representing the data contained in the form when the event was fired. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormDataEvent/formData) */ @@ -9887,7 +12125,11 @@ declare var FragmentDirective: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GPUError) */ interface GPUError { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GPUError/message) */ + /** + * The **`message`** read-only property of the A string. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GPUError/message) + */ readonly message: string; } @@ -9897,7 +12139,11 @@ interface GPUError { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GainNode) */ interface GainNode extends AudioNode { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GainNode/gain) */ + /** + * The `gain` property of the GainNode interface is an a-rate AudioParam representing the amount of gain to apply. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GainNode/gain) + */ readonly gain: AudioParam; } @@ -9912,21 +12158,53 @@ declare var GainNode: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad) */ interface Gamepad { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/axes) */ + /** + * The **`Gamepad.axes`** property of the Gamepad interface returns an array representing the controls with axes present on the device (e.g., analog thumb sticks). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/axes) + */ readonly axes: ReadonlyArray; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/buttons) */ + /** + * The **`buttons`** property of the Gamepad interface returns an array of GamepadButton objects representing the buttons present on the device. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/buttons) + */ readonly buttons: ReadonlyArray; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/connected) */ + /** + * The **`Gamepad.connected`** property of the still connected to the system. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/connected) + */ readonly connected: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/id) */ + /** + * The **`Gamepad.id`** property of the Gamepad interface returns a string containing some information about the controller. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/id) + */ readonly id: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/index) */ + /** + * The **`Gamepad.index`** property of the Gamepad interface returns an integer that is auto-incremented to be unique for each device currently connected to the system. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/index) + */ readonly index: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/mapping) */ + /** + * The **`Gamepad.mapping`** property of the remapped the controls on the device to a known layout. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/mapping) + */ readonly mapping: GamepadMappingType; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/timestamp) */ + /** + * The **`Gamepad.timestamp`** property of the representing the last time the data for this gamepad was updated. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/timestamp) + */ readonly timestamp: DOMHighResTimeStamp; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/vibrationActuator) */ + /** + * The **`vibrationActuator`** read-only property of the Gamepad interface returns a GamepadHapticActuator object, which represents haptic feedback hardware available on the controller. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Gamepad/vibrationActuator) + */ readonly vibrationActuator: GamepadHapticActuator; } @@ -9941,11 +12219,23 @@ declare var Gamepad: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton) */ interface GamepadButton { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton/pressed) */ + /** + * The **`GamepadButton.pressed`** property of the the button is currently pressed (`true`) or unpressed (`false`). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton/pressed) + */ readonly pressed: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton/touched) */ + /** + * The **`touched`** property of the a button capable of detecting touch is currently touched (`true`) or not touched (`false`). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton/touched) + */ readonly touched: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton/value) */ + /** + * The **`GamepadButton.value`** property of the current state of analog buttons on many modern gamepads, such as the triggers. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadButton/value) + */ readonly value: number; } @@ -9960,7 +12250,11 @@ declare var GamepadButton: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadEvent) */ interface GamepadEvent extends Event { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadEvent/gamepad) */ + /** + * The **`GamepadEvent.gamepad`** property of the **GamepadEvent interface** returns a Gamepad object, providing access to the associated gamepad data for fired A Gamepad object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadEvent/gamepad) + */ readonly gamepad: Gamepad; } @@ -9975,9 +12269,17 @@ declare var GamepadEvent: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadHapticActuator) */ interface GamepadHapticActuator { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadHapticActuator/playEffect) */ + /** + * The **`playEffect()`** method of the GamepadHapticActuator interface causes the hardware to play a specific vibration effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadHapticActuator/playEffect) + */ playEffect(type: GamepadHapticEffectType, params?: GamepadEffectParameters): Promise; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadHapticActuator/reset) */ + /** + * The **`reset()`** method of the GamepadHapticActuator interface stops the hardware from playing an active vibration effect. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadHapticActuator/reset) + */ reset(): Promise; } @@ -9999,11 +12301,23 @@ interface GenericTransformStream { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation) */ interface Geolocation { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation/clearWatch) */ + /** + * The **`clearWatch()`** method of the Geolocation interface is used to unregister location/error monitoring handlers previously installed using Geolocation.watchPosition(). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation/clearWatch) + */ clearWatch(watchId: number): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation/getCurrentPosition) */ + /** + * The **`getCurrentPosition()`** method of the Geolocation interface is used to get the current position of the device. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation/getCurrentPosition) + */ getCurrentPosition(successCallback: PositionCallback, errorCallback?: PositionErrorCallback | null, options?: PositionOptions): void; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition) */ + /** + * The **`watchPosition()`** method of the Geolocation interface is used to register a handler function that will be called automatically each time the position of the device changes. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition) + */ watchPosition(successCallback: PositionCallback, errorCallback?: PositionErrorCallback | null, options?: PositionOptions): number; } @@ -10019,21 +12333,53 @@ declare var Geolocation: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates) */ interface GeolocationCoordinates { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/accuracy) */ + /** + * The **`accuracy`** read-only property of the GeolocationCoordinates interface is a strictly positive `double` representing the accuracy, with a 95% confidence level, of the GeolocationCoordinates.latitude and GeolocationCoordinates.longitude properties expressed in meters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/accuracy) + */ readonly accuracy: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/altitude) */ + /** + * The **`altitude`** read-only property of the GeolocationCoordinates interface is a `double` representing the altitude of the position in meters above the WGS84 ellipsoid (which defines the nominal sea level surface). + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/altitude) + */ readonly altitude: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/altitudeAccuracy) */ + /** + * The **`altitudeAccuracy`** read-only property of the GeolocationCoordinates interface is a strictly positive `double` representing the accuracy, with a 95% confidence level, of the `altitude` expressed in meters. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/altitudeAccuracy) + */ readonly altitudeAccuracy: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/heading) */ + /** + * The **`heading`** read-only property of the GeolocationCoordinates interface is a `double` representing the direction in which the device is traveling. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/heading) + */ readonly heading: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/latitude) */ + /** + * The **`latitude`** read-only property of the GeolocationCoordinates interface is a `double` representing the latitude of the position in decimal degrees. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/latitude) + */ readonly latitude: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/longitude) */ + /** + * The **`longitude`** read-only property of the GeolocationCoordinates interface is a number which represents the longitude of a geographical position, specified in decimal degrees. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/longitude) + */ readonly longitude: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/speed) */ + /** + * The **`speed`** read-only property of the GeolocationCoordinates interface is a `double` representing the velocity of the device in meters per second. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/speed) + */ readonly speed: number | null; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/toJSON) */ + /** + * The **`toJSON()`** method of the GeolocationCoordinates interface is a Serialization; it returns a JSON representation of the GeolocationCoordinates object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/toJSON) + */ toJSON(): any; } @@ -10049,11 +12395,23 @@ declare var GeolocationCoordinates: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition) */ interface GeolocationPosition { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition/coords) */ + /** + * The **`coords`** read-only property of the GeolocationPosition interface returns a GeolocationCoordinates object representing a geographic position. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition/coords) + */ readonly coords: GeolocationCoordinates; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition/timestamp) */ + /** + * The **`timestamp`** read-only property of the GeolocationPosition interface represents the date and time that the position was acquired by the device. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition/timestamp) + */ readonly timestamp: EpochTimeStamp; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition/toJSON) */ + /** + * The **`toJSON()`** method of the GeolocationPosition interface is a Serialization; it returns a JSON representation of the GeolocationPosition object. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPosition/toJSON) + */ toJSON(): any; } @@ -10068,9 +12426,17 @@ declare var GeolocationPosition: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPositionError) */ interface GeolocationPositionError { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPositionError/code) */ + /** + * The **`code`** read-only property of the GeolocationPositionError interface is an `unsigned short` representing the error code. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPositionError/code) + */ readonly code: number; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPositionError/message) */ + /** + * The **`message`** read-only property of the GeolocationPositionError interface returns a human-readable string describing the details of the error. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/GeolocationPositionError/message) + */ readonly message: string; readonly PERMISSION_DENIED: 1; readonly POSITION_UNAVAILABLE: 2; @@ -10192,12 +12558,7 @@ interface GlobalEventHandlersEventMap { } interface GlobalEventHandlers { - /** - * Fires when the user aborts the download. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event) */ onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event) */ onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; @@ -10213,48 +12574,23 @@ interface GlobalEventHandlers { onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event) */ onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null; - /** - * Fires when the object loses the input focus. - * @param ev The focus event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event) */ onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event) */ oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when playback is possible, but would require further buffering. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event) */ oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event) */ oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when the contents of the object or selection have changed. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event) */ onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when the user clicks the left mouse button on the object - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event) */ onclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event) */ onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event) */ oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when the user clicks the right mouse button in the client area, opening the context menu. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event) */ oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event) */ oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null; @@ -10264,91 +12600,31 @@ interface GlobalEventHandlers { oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event) */ oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; - /** - * Fires when the user double-clicks the object. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event) */ ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; - /** - * Fires on the source object continuously during a drag operation. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event) */ ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; - /** - * Fires on the source object when the user releases the mouse at the close of a drag operation. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event) */ ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; - /** - * Fires on the target element when the user drags the object to a valid drop target. - * @param ev The drag event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event) */ ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; - /** - * 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](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event) */ ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; - /** - * Fires on the target element continuously while the user drags the object over a valid drop target. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event) */ ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; - /** - * Fires on the source object when the user starts to drag a text selection or selected object. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event) */ ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event) */ ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; - /** - * Occurs when the duration attribute is updated. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event) */ ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the media element is reset to its initial state. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event) */ onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the end of playback is reached. - * @param ev The event - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event) */ onended: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when an error occurs during object loading. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event) */ onerror: OnErrorEventHandler; - /** - * Fires when the object receives focus. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event) */ onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event) */ onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null; @@ -10358,119 +12634,47 @@ interface GlobalEventHandlers { oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event) */ oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when the user presses a key. - * @param ev The keyboard event - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event) */ onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; /** - * Fires when the user presses an alphanumeric key. - * @param ev The event. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event) */ onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; - /** - * Fires when the user releases a key. - * @param ev The keyboard event - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event) */ onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; - /** - * Fires immediately after the browser loads the object. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event) */ onload: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when media data is loaded at the current playback position. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event) */ onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the duration and dimensions of the media have been determined. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event) */ onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when Internet Explorer begins looking for media data. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event) */ onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event) */ onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; - /** - * Fires when the user clicks the object with either mouse button. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event) */ onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event) */ onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event) */ onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; - /** - * Fires when the user moves the mouse over the object. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event) */ onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; - /** - * Fires when the user moves the mouse pointer outside the boundaries of the object. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event) */ onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; - /** - * Fires when the user moves the mouse pointer into the object. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event) */ onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; - /** - * Fires when the user releases a mouse button while the mouse is over the object. - * @param ev The mouse event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event) */ onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event) */ onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; - /** - * Occurs when playback is paused. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event) */ onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the play method is requested. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event) */ onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the audio or video has started playing. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event) */ onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event) */ onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; @@ -10488,60 +12692,25 @@ interface GlobalEventHandlers { onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event) */ onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; - /** - * Occurs to indicate progress while downloading media data. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event) */ onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null; - /** - * Occurs when the playback rate is increased or decreased. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event) */ onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when the user resets a form. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event) */ onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event) */ onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null; - /** - * Fires when the user repositions the scroll box in the scroll bar on the object. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event) */ onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event) */ onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event) */ onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null; - /** - * Occurs when the seek operation ends. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event) */ onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the current playback position is moved. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event) */ onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Fires when the current selection changes. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event) */ onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event) */ onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; @@ -10549,28 +12718,13 @@ interface GlobalEventHandlers { onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event) */ onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when the download has stopped. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event) */ onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event) */ onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null; - /** - * Occurs if the load operation has been intentionally halted. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event) */ onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs to indicate the current playback position. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event) */ ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event) */ ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null; @@ -10590,19 +12744,9 @@ interface GlobalEventHandlers { ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event) */ ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; - /** - * Occurs when the volume is changed, or playback is muted or unmuted. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event) */ onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; - /** - * Occurs when playback stops because the next frame of a video resource is not available. - * @param ev The event. - * - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event) - */ + /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event) */ onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * @deprecated This is a legacy alias of `onanimationend`. @@ -10643,23 +12787,19 @@ interface GlobalEventHandlers { */ interface HTMLAllCollection { /** - * Returns the number of elements in the collection. + * The **`HTMLAllCollection.length`** property returns the number of items in this HTMLAllCollection. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAllCollection/length) */ readonly length: number; /** - * Returns the item with index index from the collection (determined by tree order). + * The **`item()`** method of the HTMLAllCollection interface returns the element located at the specified offset into the collection, or the element with the specified value for its `id` or `name` attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAllCollection/item) */ item(nameOrIndex?: string): HTMLCollection | Element | null; /** - * Returns the item with ID or name name from the collection. - * - * If there are multiple matching items, then an HTMLCollection object containing all those elements is returned. - * - * Only button, form, iframe, input, map, meta, object, select, and textarea elements can have a name for the purpose of this method; their name is given by the value of their name attribute. + * The **`namedItem()`** method of the HTMLAllCollection interface returns the first Element in the collection whose `id` or `name` attribute matches the specified name, or `null` if no element matches. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAllCollection/namedItem) */ @@ -10678,65 +12818,70 @@ declare var HTMLAllCollection: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement) */ interface HTMLAnchorElement extends HTMLElement, HTMLHyperlinkElementUtils { - /** - * Sets or retrieves the character set used to encode the object. - * @deprecated - */ + /** @deprecated */ charset: string; + /** @deprecated */ + coords: string; /** - * Sets or retrieves the coordinates of the object. - * @deprecated + * The **`HTMLAnchorElement.download`** property is a string indicating that the linked resource is intended to be downloaded rather than displayed in the browser. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/download) */ - coords: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/download) */ download: string; /** - * Sets or retrieves the language code of the object. + * The **`hreflang`** property of the HTMLAnchorElement interface is a string that is the language of the linked resource. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/hreflang) */ hreflang: string; + /** @deprecated */ + name: string; /** - * Sets or retrieves the shape of the object. - * @deprecated + * The **`ping`** property of the HTMLAnchorElement interface is a space-separated list of URLs. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/ping) */ - name: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/ping) */ ping: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/referrerPolicy) */ + /** + * The **`HTMLAnchorElement.referrerPolicy`** property reflect the HTML `referrerpolicy` attribute of the A string; one of the following: - `no-referrer` - : The Referer header will be omitted entirely. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/referrerPolicy) + */ referrerPolicy: string; /** - * Sets or retrieves the relationship between the object and the destination of the link. + * The **`HTMLAnchorElement.rel`** property reflects the `rel` attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/rel) */ rel: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/relList) */ - get relList(): DOMTokenList; - set relList(value: string); /** - * Sets or retrieves the relationship between the object and the destination of the link. - * @deprecated + * The **`HTMLAnchorElement.relList`** read-only property reflects the `rel` attribute. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/relList) */ + get relList(): DOMTokenList; + set relList(value: string); + /** @deprecated */ rev: string; - /** - * Sets or retrieves the shape of the object. - * @deprecated - */ + /** @deprecated */ shape: string; /** - * Sets or retrieves the window or frame at which to target content. + * The **`target`** property of the HTMLAnchorElement interface is a string that indicates where to display the linked resource. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/target) */ target: string; /** - * Retrieves or sets the text of the object as a string. + * The **`text`** property of the HTMLAnchorElement represents the text inside the element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/text) */ text: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/type) */ + /** + * The **`type`** property of the HTMLAnchorElement interface is a string that indicates the MIME type of the linked resource. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/type) + */ type: string; addEventListener(type: K, listener: (this: HTMLAnchorElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -10756,41 +12901,58 @@ declare var HTMLAnchorElement: { */ interface HTMLAreaElement extends HTMLElement, HTMLHyperlinkElementUtils { /** - * Sets or retrieves a text alternative to the graphic. + * The **`alt`** property of the HTMLAreaElement interface specifies the text of the hyperlink, defining the textual label for an image map's link. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/alt) */ alt: string; /** - * Sets or retrieves the coordinates of the object. + * The **`coords`** property of the HTMLAreaElement interface specifies the coordinates of the element's shape as a list of floating-point numbers. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/coords) */ coords: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/download) */ - download: string; /** - * Sets or gets whether clicks in this region cause action. - * @deprecated + * The **`download`** property of the HTMLAreaElement interface is a string indicating that the linked resource is intended to be downloaded rather than displayed in the browser. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/download) */ + download: string; + /** @deprecated */ noHref: boolean; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/ping) */ + /** + * The **`ping`** property of the HTMLAreaElement interface is a space-separated list of URLs. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/ping) + */ ping: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/referrerPolicy) */ + /** + * The **`HTMLAreaElement.referrerPolicy`** property reflect the HTML `referrerpolicy` attribute of the resource. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/referrerPolicy) + */ referrerPolicy: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/rel) */ + /** + * The **`HTMLAreaElement.rel`** property reflects the `rel` attribute. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/rel) + */ rel: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/relList) */ + /** + * The **`HTMLAreaElement.relList`** read-only property reflects the `rel` attribute. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/relList) + */ get relList(): DOMTokenList; set relList(value: string); /** - * Sets or retrieves the shape of the object. + * The **`shape`** property of the HTMLAreaElement interface specifies the shape of an image map area. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/shape) */ shape: string; /** - * Sets or retrieves the window or frame at which to target content. + * The **`target`** property of the HTMLAreaElement interface is a string that indicates where to display the linked resource. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/target) */ @@ -10829,10 +12991,7 @@ declare var HTMLAudioElement: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLBRElement) */ interface HTMLBRElement extends HTMLElement { - /** - * Sets or retrieves the side on which floating objects are not to be positioned when any IHTMLBlockElement is inserted into the document. - * @deprecated - */ + /** @deprecated */ clear: string; addEventListener(type: K, listener: (this: HTMLBRElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; @@ -10852,13 +13011,13 @@ declare var HTMLBRElement: { */ interface HTMLBaseElement extends HTMLElement { /** - * Gets or sets the baseline URL on which relative links are based. + * The **`href`** property of the HTMLBaseElement interface contains a string that is the URL to use as the base for relative URLs. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLBaseElement/href) */ href: string; /** - * Sets or retrieves the window or frame at which to target content. + * The `target` property of the HTMLBaseElement interface is a string that represents the default target tab to show the resulting output for hyperlinks and form elements. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLBaseElement/target) */ @@ -10912,93 +13071,104 @@ declare var HTMLBodyElement: { * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement) */ interface HTMLButtonElement extends HTMLElement, PopoverInvokerElement { - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/disabled) */ + /** + * The **`HTMLButtonElement.disabled`** property indicates whether the control is disabled, meaning that it does not accept any clicks. + * + * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/disabled) + */ disabled: boolean; /** - * Retrieves a reference to the form that the object is embedded in. + * The **`form`** read-only property of the HTMLButtonElement interface returns an HTMLFormElement object that owns this button, or `null` if this button is not owned by any form. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/form) */ readonly form: HTMLFormElement | null; /** - * Overrides the action attribute (where the data on a form is sent) on the parent form element. + * The **`formAction`** property of the HTMLButtonElement interface is the URL of the program that is executed on the server when the form that owns this control is submitted. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formAction) */ formAction: string; /** - * Used to override the encoding (formEnctype attribute) specified on the form element. + * The **`formEnctype`** property of the HTMLButtonElement interface is the MIME_type of the content sent to the server when the form is submitted. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formEnctype) */ formEnctype: string; /** - * Overrides the submit method attribute previously specified on a form element. + * The **`formMethod`** property of the HTMLButtonElement interface is the HTTP method used to submit the form if the button element is the control that submits the form. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formMethod) */ formMethod: string; /** - * Overrides any validation or required attributes on a form or form elements to allow it to be submitted without validation. This can be used to create a "save draft"-type submit option. + * The **`formNoValidate`** property of the HTMLButtonElement interface is a boolean value indicating if the form will bypass constraint validation when submitted via the button. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formNoValidate) */ formNoValidate: boolean; /** - * Overrides the target attribute on a form element. + * The **`formTarget`** property of the HTMLButtonElement interface is the tab, window, or iframe where the response of the submitted form is to be displayed. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formTarget) */ formTarget: string; - /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/labels) */ + /** + * The **`HTMLButtonElement.labels`** read-only property returns a A NodeList containing the `