Skip to content

fix: type observer callback entries and box sizes as non-empty tuples #2515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
homayounmmdy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: type observer callback entries and box sizes as non-empty tuples #2515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions baselines/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31257,13 +31257,13 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/borderBoxSize)
*/
readonly borderBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly borderBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentBoxSize`** read-only property of the ResizeObserverEntry interface returns an array containing the new content box size of the observed element when the callback is run.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/contentBoxSize)
*/
readonly contentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly contentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentRect`** read-only property of the ResizeObserverEntry interface returns a DOMRectReadOnly object containing the new size of the observed element when the callback is run. Note that this is better supported than ResizeObserverEntry.borderBoxSize or ResizeObserverEntry.contentBoxSize, but it is left over from an earlier implementation of the Resize Observer API, is still included in the spec for web compat reasons, and may be deprecated in future versions.
*
Expand All @@ -31275,7 +31275,7 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/devicePixelContentBoxSize)
*/
readonly devicePixelContentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly devicePixelContentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`target`** read-only property of the ResizeObserverEntry interface returns a reference to the Element or SVGElement that is being observed.
*
Expand Down Expand Up @@ -43836,7 +43836,7 @@ interface MediaSessionActionHandler {
}

interface MutationCallback {
(mutations: MutationRecord[], observer: MutationObserver): void;
(mutations: [MutationRecord, ...MutationRecord[]], observer: MutationObserver): void;
}

interface NavigationInterceptHandler {
Expand Down Expand Up @@ -43892,7 +43892,7 @@ interface ReportingObserverCallback {
}

interface ResizeObserverCallback {
(entries: ResizeObserverEntry[], observer: ResizeObserver): void;
(entries: [ResizeObserverEntry, ...ResizeObserverEntry[]], observer: ResizeObserver): void;
}

interface SchedulerPostTaskCallback {
Expand Down
10 changes: 5 additions & 5 deletions baselines/ts5.5/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31233,13 +31233,13 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/borderBoxSize)
*/
readonly borderBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly borderBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentBoxSize`** read-only property of the ResizeObserverEntry interface returns an array containing the new content box size of the observed element when the callback is run.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/contentBoxSize)
*/
readonly contentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly contentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentRect`** read-only property of the ResizeObserverEntry interface returns a DOMRectReadOnly object containing the new size of the observed element when the callback is run. Note that this is better supported than ResizeObserverEntry.borderBoxSize or ResizeObserverEntry.contentBoxSize, but it is left over from an earlier implementation of the Resize Observer API, is still included in the spec for web compat reasons, and may be deprecated in future versions.
*
Expand All @@ -31251,7 +31251,7 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/devicePixelContentBoxSize)
*/
readonly devicePixelContentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly devicePixelContentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`target`** read-only property of the ResizeObserverEntry interface returns a reference to the Element or SVGElement that is being observed.
*
Expand Down Expand Up @@ -43810,7 +43810,7 @@ interface MediaSessionActionHandler {
}

interface MutationCallback {
(mutations: MutationRecord[], observer: MutationObserver): void;
(mutations: [MutationRecord, ...MutationRecord[]], observer: MutationObserver): void;
}

interface NavigationInterceptHandler {
Expand Down Expand Up @@ -43866,7 +43866,7 @@ interface ReportingObserverCallback {
}

interface ResizeObserverCallback {
(entries: ResizeObserverEntry[], observer: ResizeObserver): void;
(entries: [ResizeObserverEntry, ...ResizeObserverEntry[]], observer: ResizeObserver): void;
}

interface SchedulerPostTaskCallback {
Expand Down
10 changes: 5 additions & 5 deletions baselines/ts5.6/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31254,13 +31254,13 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/borderBoxSize)
*/
readonly borderBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly borderBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentBoxSize`** read-only property of the ResizeObserverEntry interface returns an array containing the new content box size of the observed element when the callback is run.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/contentBoxSize)
*/
readonly contentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly contentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentRect`** read-only property of the ResizeObserverEntry interface returns a DOMRectReadOnly object containing the new size of the observed element when the callback is run. Note that this is better supported than ResizeObserverEntry.borderBoxSize or ResizeObserverEntry.contentBoxSize, but it is left over from an earlier implementation of the Resize Observer API, is still included in the spec for web compat reasons, and may be deprecated in future versions.
*
Expand All @@ -31272,7 +31272,7 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/devicePixelContentBoxSize)
*/
readonly devicePixelContentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly devicePixelContentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`target`** read-only property of the ResizeObserverEntry interface returns a reference to the Element or SVGElement that is being observed.
*
Expand Down Expand Up @@ -43833,7 +43833,7 @@ interface MediaSessionActionHandler {
}

interface MutationCallback {
(mutations: MutationRecord[], observer: MutationObserver): void;
(mutations: [MutationRecord, ...MutationRecord[]], observer: MutationObserver): void;
}

interface NavigationInterceptHandler {
Expand Down Expand Up @@ -43889,7 +43889,7 @@ interface ReportingObserverCallback {
}

interface ResizeObserverCallback {
(entries: ResizeObserverEntry[], observer: ResizeObserver): void;
(entries: [ResizeObserverEntry, ...ResizeObserverEntry[]], observer: ResizeObserver): void;
}

interface SchedulerPostTaskCallback {
Expand Down
10 changes: 5 additions & 5 deletions baselines/ts5.9/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31254,13 +31254,13 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/borderBoxSize)
*/
readonly borderBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly borderBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentBoxSize`** read-only property of the ResizeObserverEntry interface returns an array containing the new content box size of the observed element when the callback is run.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/contentBoxSize)
*/
readonly contentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly contentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`contentRect`** read-only property of the ResizeObserverEntry interface returns a DOMRectReadOnly object containing the new size of the observed element when the callback is run. Note that this is better supported than ResizeObserverEntry.borderBoxSize or ResizeObserverEntry.contentBoxSize, but it is left over from an earlier implementation of the Resize Observer API, is still included in the spec for web compat reasons, and may be deprecated in future versions.
*
Expand All @@ -31272,7 +31272,7 @@ interface ResizeObserverEntry {
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ResizeObserverEntry/devicePixelContentBoxSize)
*/
readonly devicePixelContentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly devicePixelContentBoxSize: readonly [ResizeObserverSize, ...ResizeObserverSize[]];
/**
* The **`target`** read-only property of the ResizeObserverEntry interface returns a reference to the Element or SVGElement that is being observed.
*
Expand Down Expand Up @@ -43833,7 +43833,7 @@ interface MediaSessionActionHandler {
}

interface MutationCallback {
(mutations: MutationRecord[], observer: MutationObserver): void;
(mutations: [MutationRecord, ...MutationRecord[]], observer: MutationObserver): void;
}

interface NavigationInterceptHandler {
Expand Down Expand Up @@ -43889,7 +43889,7 @@ interface ReportingObserverCallback {
}

interface ResizeObserverCallback {
(entries: ResizeObserverEntry[], observer: ResizeObserver): void;
(entries: [ResizeObserverEntry, ...ResizeObserverEntry[]], observer: ResizeObserver): void;
}

interface SchedulerPostTaskCallback {
Expand Down
47 changes: 47 additions & 0 deletions inputfiles/overridingTypes.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,38 @@
"overrideType": "T"
}
}
},
"ResizeObserverCallback": {
"signature": {
"0": {
"param": [
{
"name": "entries",
"overrideType": "[ResizeObserverEntry, ...ResizeObserverEntry[]]"
},
{
"name": "observer",
"overrideType": "ResizeObserver"
}
]
}
}
},
"MutationCallback": {
"signature": {
"0": {
"param": [
{
"name": "mutations",
"overrideType": "[MutationRecord, ...MutationRecord[]]"
},
{
"name": "observer",
"overrideType": "MutationObserver"
}
]
}
}
}
}
},
Expand Down Expand Up @@ -2861,6 +2893,21 @@
"TrustedTypePolicyFactory": {
"exposed": ""
},
"ResizeObserverEntry": {
"properties": {
"property": {
"contentBoxSize": {
"overrideType": "readonly [ResizeObserverSize, ...ResizeObserverSize[]]"
},
"borderBoxSize": {
"overrideType": "readonly [ResizeObserverSize, ...ResizeObserverSize[]]"
},
"devicePixelContentBoxSize": {
"overrideType": "readonly [ResizeObserverSize, ...ResizeObserverSize[]]"
}
}
}
}
}
},
"dictionaries": {
Expand Down
Loading