From 9e017560fa40de31217200e10d6248827c3d2c19 Mon Sep 17 00:00:00 2001 From: Kagami Sascha Rosylight Date: Thu, 4 Dec 2025 09:52:19 +0100 Subject: [PATCH] Update MDN comments --- baselines/audioworklet.generated.d.ts | 28 +-- baselines/dom.generated.d.ts | 148 ++++++------- baselines/serviceworker.generated.d.ts | 34 +-- baselines/sharedworker.generated.d.ts | 32 +-- baselines/ts5.5/audioworklet.generated.d.ts | 28 +-- baselines/ts5.5/dom.generated.d.ts | 148 ++++++------- baselines/ts5.5/serviceworker.generated.d.ts | 34 +-- baselines/ts5.5/sharedworker.generated.d.ts | 32 +-- baselines/ts5.5/webworker.generated.d.ts | 34 +-- baselines/ts5.6/audioworklet.generated.d.ts | 28 +-- baselines/ts5.6/dom.generated.d.ts | 148 ++++++------- baselines/ts5.6/serviceworker.generated.d.ts | 34 +-- baselines/ts5.6/sharedworker.generated.d.ts | 32 +-- baselines/ts5.6/webworker.generated.d.ts | 34 +-- baselines/ts5.9/audioworklet.generated.d.ts | 28 +-- baselines/ts5.9/dom.generated.d.ts | 148 ++++++------- baselines/ts5.9/serviceworker.generated.d.ts | 34 +-- baselines/ts5.9/sharedworker.generated.d.ts | 32 +-- baselines/ts5.9/webworker.generated.d.ts | 34 +-- baselines/webworker.generated.d.ts | 34 +-- inputfiles/mdn.json | 214 ++++++++++--------- 21 files changed, 669 insertions(+), 649 deletions(-) diff --git a/baselines/audioworklet.generated.d.ts b/baselines/audioworklet.generated.d.ts index 9df737331..351d0a92b 100644 --- a/baselines/audioworklet.generated.d.ts +++ b/baselines/audioworklet.generated.d.ts @@ -345,14 +345,14 @@ declare var ByteLengthQueuingStrategy: { }; /** - * The **`CompressionStream`** interface of the Compression Streams API is an API for compressing a stream of data. + * The **`CompressionStream`** interface of the Compression Streams API compresses a stream of data. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompressionStream) */ interface CompressionStream extends GenericTransformStream { - /** The **`readable`** read-only property of the CompressionStream interface returns a ReadableStream. */ + /** The **`readable`** read-only property of the CompressionStream interface returns a ReadableStream that emits compressed data as Uint8Array chunks. */ readonly readable: ReadableStream>; - /** The **`writable`** read-only property of the CompressionStream interface returns a WritableStream. */ + /** The **`writable`** read-only property of the CompressionStream interface returns a WritableStream that accepts uncompressed data to be compressed, in the form of ArrayBuffer, TypedArray, or DataView chunks. */ readonly writable: WritableStream; } @@ -491,14 +491,14 @@ declare var DOMException: { }; /** - * The **`DecompressionStream`** interface of the Compression Streams API is an API for decompressing a stream of data. + * The **`DecompressionStream`** interface of the Compression Streams API decompresses a stream of data. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DecompressionStream) */ interface DecompressionStream extends GenericTransformStream { - /** The **`readable`** read-only property of the DecompressionStream interface returns a ReadableStream. */ + /** The **`readable`** read-only property of the DecompressionStream interface returns a ReadableStream that emits decompressed data as Uint8Array chunks. */ readonly readable: ReadableStream>; - /** The **`writable`** read-only property of the DecompressionStream interface returns a WritableStream. */ + /** The **`writable`** read-only property of the DecompressionStream interface returns a WritableStream that accepts compressed data to be decompressed, in the form of ArrayBuffer, TypedArray, or DataView chunks. */ readonly writable: WritableStream; } @@ -1118,14 +1118,14 @@ interface TextDecoderCommon { } /** - * The **`TextDecoderStream`** interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings. It is the streaming equivalent of TextDecoder. + * The **`TextDecoderStream`** interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings. It is the streaming equivalent of TextDecoder. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoderStream) */ interface TextDecoderStream extends GenericTransformStream, TextDecoderCommon { - /** The **`readable`** read-only property of the TextDecoderStream interface returns a ReadableStream. */ + /** The **`readable`** read-only property of the TextDecoderStream interface returns a ReadableStream that emits decoded strings. */ readonly readable: ReadableStream; - /** The **`writable`** read-only property of the TextDecoderStream interface returns a WritableStream. */ + /** The **`writable`** read-only property of the TextDecoderStream interface returns a WritableStream that accepts binary data, in the form of ArrayBuffer, TypedArray, or DataView chunks (SharedArrayBuffer and its views are also allowed), to be decoded into strings. */ readonly writable: WritableStream; } @@ -1169,14 +1169,14 @@ interface TextEncoderCommon { } /** - * The **`TextEncoderStream`** interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding. It is the streaming equivalent of TextEncoder. + * The **`TextEncoderStream`** interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding. It is the streaming equivalent of TextEncoder. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoderStream) */ interface TextEncoderStream extends GenericTransformStream, TextEncoderCommon { - /** The **`readable`** read-only property of the TextEncoderStream interface returns a ReadableStream. */ + /** The **`readable`** read-only property of the TextEncoderStream interface returns a ReadableStream that emits encoded binary data as Uint8Array chunks. */ readonly readable: ReadableStream>; - /** The **`writable`** read-only property of the TextEncoderStream interface returns a WritableStream. */ + /** The **`writable`** read-only property of the TextEncoderStream interface returns a WritableStream that accepts strings to be encoded into binary data. */ readonly writable: WritableStream; } @@ -1192,13 +1192,13 @@ declare var TextEncoderStream: { */ interface TransformStream { /** - * The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this TransformStream. + * The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this TransformStream. This stream emits the transformed output data. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/readable) */ readonly readable: ReadableStream; /** - * The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this TransformStream. + * The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this TransformStream. This stream accepts input data that will be transformed and emitted to the readable stream. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/writable) */ diff --git a/baselines/dom.generated.d.ts b/baselines/dom.generated.d.ts index 478fd753e..0af706106 100644 --- a/baselines/dom.generated.d.ts +++ b/baselines/dom.generated.d.ts @@ -4837,7 +4837,7 @@ declare var CSSCounterStyleRule: { */ interface CSSFontFaceRule extends CSSRule { /** - * The read-only **`style`** property of the CSSFontFaceRule interface returns the style information from the @font-face at-rule. This will be in the form of a CSSStyleDeclaration object. + * The read-only **`style`** property of the CSSFontFaceRule interface contains a CSSStyleDeclaration object representing the descriptors available in the @font-face rule's body. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSFontFaceRule/style) */ @@ -4969,7 +4969,7 @@ interface CSSImportRule extends CSSRule { */ readonly layerName: string | null; /** - * The read-only **`media`** property of the CSSImportRule interface returns a MediaList object, containing the value of the media attribute of the associated stylesheet. + * The read-only **`media`** property of the CSSImportRule interface returns a MediaList object representing the media query list of the @import rule. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSImportRule/media) */ @@ -5007,7 +5007,7 @@ interface CSSKeyframeRule extends CSSRule { */ keyText: string; /** - * The read-only **`CSSKeyframeRule.style`** property is the CSSStyleDeclaration interface for the declaration block of the CSSKeyframeRule. + * The read-only **`style`** property of the CSSKeyframeRule interface contains a CSSStyleDeclaration object representing the descriptors available in the @keyframes rule's body. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSKeyframeRule/style) */ @@ -5297,7 +5297,7 @@ declare var CSSMatrixComponent: { */ interface CSSMediaRule extends CSSConditionRule { /** - * The read-only **`media`** property of the CSSMediaRule interface returns a MediaList representing the intended destination medium for style information. + * The read-only **`media`** property of the CSSMediaRule interface contains a MediaList object representing the media query list of the @media rule. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMediaRule/media) */ @@ -5501,7 +5501,7 @@ interface CSSPageRule extends CSSGroupingRule { */ selectorText: string; /** - * The **`style`** read-only property of the CSSPageRule interface returns a CSSPageDescriptors object. This represents a CSS declaration block for a CSS @page at-rule, and exposes style information and various style-related methods and properties for the page. + * The read-only **`style`** property of the CSSPageRule interface contains a CSSPageDescriptors object representing the descriptors available in the @page rule's body. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPageRule/style) */ @@ -5699,7 +5699,7 @@ interface CSSPositionTryRule extends CSSRule { */ readonly name: string; /** - * The **`style`** read-only property of the CSSPositionTryRule interface returns a CSSPositionTryDescriptors object representing the declarations set in the body of the @position-try at-rule. + * The read-only **`style`** property of the CSSPositionTryRule interface contains a CSSPositionTryDescriptors object representing the descriptors available in the @position-try rule's body. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSPositionTryRule/style) */ @@ -6194,7 +6194,7 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase { */ animationRangeStart: string; /** - * The animation-timeline CSS property specifies the timeline that is used to control the progress of a CSS animation. + * The animation-timeline CSS property specifies the timeline used to control the progress of a CSS animation. * * [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/animation-timeline) */ @@ -8273,13 +8273,13 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase { */ scrollSnapType: string; /** - * The scroll-timeline CSS shorthand property is used to define a named scroll progress timeline, which is progressed through by scrolling a scrollable element (scroller) between top and bottom (or left and right). scroll-timeline is set on the scroller that will provide the timeline. The starting scroll position represents 0% progress and the ending scroll position represents 100% progress. If the 0% position and 100% position coincide (i.e., the scroll container has no overflow to scroll), the timeline is inactive. + * The scroll-timeline CSS shorthand property is used to define a named scroll progress timeline, which is progressed through by scrolling a scrollable element (scroller) between top and bottom (or left and right). * * [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/scroll-timeline) */ scrollTimeline: string; /** - * The scroll-timeline-axis CSS property is used to specify the scrollbar direction that will be used to provide the timeline for a named scroll progress timeline animation, which is progressed through by scrolling a scrollable element (scroller) between top and bottom (or left and right). scroll-timeline is set on the scroller that will provide the timeline. See CSS scroll-driven animations for more details. + * The scroll-timeline-axis CSS property is used to specify the scrollbar direction that will be used to provide the timeline for a scroll driven animation animation, which is progressed through by scrolling a scrollable element (scroller). * * [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/scroll-timeline-axis) */ @@ -8687,7 +8687,7 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase { */ verticalAlign: string; /** - * The view-timeline CSS shorthand property is used to define a named view progress timeline, which is progressed through based on the change in visibility of an element (known as the subject) inside a scrollable element (scroller). view-timeline is set on the subject. + * The view-timeline CSS shorthand property defines a named view progress timeline's name, direction, and inset values. * * [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/view-timeline) */ @@ -9244,7 +9244,7 @@ interface CSSStyleRule extends CSSGroupingRule { */ selectorText: string; /** - * The read-only **`style`** property is a CSSStyleProperties object that represents the inline styles of a style rule (CSSStyleRule). + * The read-only **`style`** property of the CSSStyleRule interface contains a CSSStyleProperties object representing the properties list in this style rule's body. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSStyleRule/style) */ @@ -10300,14 +10300,14 @@ declare var CompositionEvent: { }; /** - * The **`CompressionStream`** interface of the Compression Streams API is an API for compressing a stream of data. + * The **`CompressionStream`** interface of the Compression Streams API compresses a stream of data. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompressionStream) */ interface CompressionStream extends GenericTransformStream { - /** The **`readable`** read-only property of the CompressionStream interface returns a ReadableStream. */ + /** The **`readable`** read-only property of the CompressionStream interface returns a ReadableStream that emits compressed data as Uint8Array chunks. */ readonly readable: ReadableStream>; - /** The **`writable`** read-only property of the CompressionStream interface returns a WritableStream. */ + /** The **`writable`** read-only property of the CompressionStream interface returns a WritableStream that accepts uncompressed data to be compressed, in the form of ArrayBuffer, TypedArray, or DataView chunks. */ readonly writable: WritableStream; } @@ -11783,14 +11783,14 @@ declare var DataTransferItemList: { }; /** - * The **`DecompressionStream`** interface of the Compression Streams API is an API for decompressing a stream of data. + * The **`DecompressionStream`** interface of the Compression Streams API decompresses a stream of data. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DecompressionStream) */ interface DecompressionStream extends GenericTransformStream { - /** The **`readable`** read-only property of the DecompressionStream interface returns a ReadableStream. */ + /** The **`readable`** read-only property of the DecompressionStream interface returns a ReadableStream that emits decompressed data as Uint8Array chunks. */ readonly readable: ReadableStream>; - /** The **`writable`** read-only property of the DecompressionStream interface returns a WritableStream. */ + /** The **`writable`** read-only property of the DecompressionStream interface returns a WritableStream that accepts compressed data to be decompressed, in the form of ArrayBuffer, TypedArray, or DataView chunks. */ readonly writable: WritableStream; } @@ -12191,7 +12191,7 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve */ readonly links: HTMLCollectionOf; /** - * The **`Document.location`** read-only property returns a Location object, which contains information about the URL of the document and provides methods for changing that URL and loading another URL. + * The read-only **`location`** property of the Document interface returns a Location object, which contains information about the URL of the document and provides methods for changing that URL and loading another URL. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/location) */ @@ -12545,7 +12545,7 @@ interface Document extends Node, DocumentOrShadowRoot, FontFaceSource, GlobalEve */ hasStorageAccess(): Promise; /** - * The Document object's **`importNode()`** method creates a copy of a Node or DocumentFragment from another document, to be inserted into the current document later. + * The **`importNode()`** method of the Document interface creates a copy of a Node or DocumentFragment from another document, to be inserted into the current document later. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/importNode) */ @@ -12928,7 +12928,7 @@ interface Element extends Node, ARIAMixin, Animatable, ChildNode, NonDocumentTyp */ readonly attributes: NamedNodeMap; /** - * The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the class attributes of the element. This can then be used to manipulate the class list. + * The read-only **`classList`** property of the Element interface contains a live DOMTokenList collection representing the class attribute of the element. This can then be used to manipulate the class list. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList) */ @@ -13006,7 +13006,7 @@ interface Element extends Node, ARIAMixin, Animatable, ChildNode, NonDocumentTyp outerHTML: string; readonly ownerDocument: Document; /** - * 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. These can be used to style parts of a shadow DOM, via the ::part pseudo-element. + * The read-only **`part`** property of the Element interface contains a DOMTokenList object representing the part identifier(s) of the element. It reflects the element's part content attribute. These can be used to style parts of a shadow DOM, via the ::part pseudo-element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part) */ @@ -15303,7 +15303,7 @@ interface HTMLAnchorElement extends HTMLElement, HTMLHyperlinkElementUtils { */ rel: string; /** - * The **`HTMLAnchorElement.relList`** read-only property reflects the rel attribute. It is a live DOMTokenList containing the set of link types indicating the relationship between the resource represented by the element and the current document. + * The read-only **`relList`** property of the HTMLAnchorElement returns a live DOMTokenList object containing the set of link types indicating the relationship between the resource represented by the element and the current document. It reflects the element's rel content attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/relList) */ @@ -15387,7 +15387,7 @@ interface HTMLAreaElement extends HTMLElement, HTMLHyperlinkElementUtils { */ rel: string; /** - * The **`HTMLAreaElement.relList`** read-only property reflects the rel attribute. It is a live DOMTokenList containing the set of link types indicating the relationship between the resource represented by the element and the current document. + * The read-only **`relList`** property of the HTMLAreaElement returns a live DOMTokenList object containing the set of link types indicating the relationship between the resource represented by the element and the current document. It reflects the element's rel content attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/relList) */ @@ -16396,7 +16396,7 @@ interface HTMLFormElement extends HTMLElement { */ rel: string; /** - * The **`relList`** read-only property of the HTMLFormElement interface reflects the rel attribute. It is a live DOMTokenList containing the set of link types indicating the relationship between the resource represented by the
element and the current document. + * The read-only **`relList`** property of the HTMLFormElement returns a live DOMTokenList object containing the set of link types indicating the relationship between the resource represented by the element and the current document. It reflects the element's rel content attribute. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/relList) */ @@ -16753,7 +16753,7 @@ interface HTMLIFrameElement extends HTMLElement { */ referrerPolicy: ReferrerPolicy; /** - * The **`sandbox`** read-only property of the HTMLIFrameElement interface returns a DOMTokenList indicating extra restrictions on the behavior of the nested content. + * The read-only **`sandbox`** property of the HTMLIFrameElement returns a live DOMTokenList object indicating extra restrictions on the behavior of the nested content. It reflects the