Skip to content

Commit 5239b24

Browse files
sandersnsandersn
authored
Merge pull request #563 from saschanaz/mark-deprecated
Mark added types as deprecated
2 parents 91f5030 + fd3ff81 commit 5239b24

File tree

6 files changed

+60
-17
lines changed

6 files changed

+60
-17
lines changed

‎baselines/dom.generated.d.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4100,6 +4100,7 @@ interface Document extends Node, NonElementParentNode, DocumentOrShadowRoot, Par
41004100
/** @deprecated */
41014101
captureEvents(): void;
41024102
caretPositionFromPoint(x: number, y: number): CaretPosition | null;
4103+
/** @deprecated */
41034104
caretRangeFromPoint(x: number, y: number): Range;
41044105
/** @deprecated */
41054106
clear(): void;
@@ -4326,7 +4327,9 @@ interface Document extends Node, NonElementParentNode, DocumentOrShadowRoot, Par
43264327
* @param filter A custom NodeFilter function to use.
43274328
* @param entityReferenceExpansion A flag that specifies whether entity reference nodes are expanded.
43284329
*/
4329-
createTreeWalker(root: Node, whatToShow?: number, filter?: NodeFilter | null, entityReferenceExpansion?: boolean): TreeWalker;
4330+
createTreeWalker(root: Node, whatToShow?: number, filter?: NodeFilter | null): TreeWalker;
4331+
/** @deprecated */
4332+
createTreeWalker(root: Node, whatToShow: number, filter: NodeFilter | null, entityReferenceExpansion?: boolean): TreeWalker;
43304333
/**
43314334
* Returns the element for the specified x coordinate and the specified y coordinate.
43324335
* @param x The x-offset
@@ -4852,6 +4855,7 @@ interface Event {
48524855
*/
48534856
readonly isTrusted: boolean;
48544857
returnValue: boolean;
4858+
/** @deprecated */
48554859
readonly srcElement: Element | null;
48564860
/**
48574861
* Returns the object to which event is dispatched (its target).
@@ -9289,7 +9293,9 @@ interface Location {
92899293
/**
92909294
* Reloads the current page.
92919295
*/
9292-
reload(forcedReload?: boolean): void;
9296+
reload(): void;
9297+
/** @deprecated */
9298+
reload(forcedReload: boolean): void;
92939299
/**
92949300
* Removes the current page from the session history and navigates to the given URL.
92959301
*/
@@ -10263,6 +10269,7 @@ interface Node extends EventTarget {
1026310269
* Returns the last child.
1026410270
*/
1026510271
readonly lastChild: ChildNode | null;
10272+
/** @deprecated */
1026610273
readonly namespaceURI: string | null;
1026710274
/**
1026810275
* Returns the next sibling.
@@ -17658,6 +17665,7 @@ type IDBKeyPath = string;
1765817665
type Transferable = ArrayBuffer | MessagePort | ImageBitmap;
1765917666
type RTCIceGatherCandidate = RTCIceCandidateDictionary | RTCIceCandidateComplete;
1766017667
type RTCTransport = RTCDtlsTransport | RTCSrtpSdesTransport;
17668+
/** @deprecated */
1766117669
type MouseWheelEvent = WheelEvent;
1766217670
type WindowProxy = Window;
1766317671
type AlignSetting = "start" | "center" | "end" | "left" | "right";

‎baselines/webworker.generated.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1020,7 +1020,6 @@ interface Event {
10201020
*/
10211021
readonly isTrusted: boolean;
10221022
returnValue: boolean;
1023-
readonly srcElement: object | null;
10241023
/**
10251024
* Returns the object to which event is dispatched (its target).
10261025
*/

‎inputfiles/addedTypes.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2628,12 +2628,13 @@
26282628
},
26292629
{
26302630
"new-type": "MouseWheelEvent",
2631-
"type": "WheelEvent"
2631+
"type": "WheelEvent",
2632+
"deprecated": 1
26322633
},
26332634
{
26342635
"new-type": "WindowProxy",
26352636
"type": "Window"
26362637
}
26372638
]
26382639
}
2639-
}
2640+
}

‎inputfiles/overridingTypes.json

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -436,12 +436,36 @@
436436
]
437437
},
438438
"createTreeWalker": {
439-
"override-signatures": [
440-
"createTreeWalker(root: Node, whatToShow?: number, filter?: NodeFilter | null, entityReferenceExpansion?: boolean): TreeWalker"
439+
"signature": [
440+
{
441+
"type": "TreeWalker",
442+
"param": [
443+
{
444+
"name": "root",
445+
"type": "Node"
446+
},
447+
{
448+
"name": "whatToShow",
449+
"type": "unsigned long"
450+
},
451+
{
452+
"name": "filter",
453+
"type": "NodeFilter",
454+
"nullable": 1
455+
},
456+
{
457+
"name": "entityReferenceExpansion",
458+
"type": "boolean",
459+
"optional": 1
460+
}
461+
],
462+
"deprecated": 1
463+
}
441464
]
442465
},
443466
"caretRangeFromPoint": {
444467
"name": "caretRangeFromPoint",
468+
"deprecated": 1,
445469
"override-signatures" :[
446470
"caretRangeFromPoint(x: number, y: number): Range"
447471
]
@@ -560,7 +584,8 @@
560584
"namespaceURI": {
561585
"name":"namespaceURI",
562586
"read-only": 1,
563-
"override-type": "string | null"
587+
"override-type": "string | null",
588+
"deprecated": 1
564589
}
565590
}
566591
}
@@ -2199,13 +2224,13 @@
21992224
"override-exposed": "Window Worker"
22002225
},
22012226
"Event": {
2202-
"name": "Event",
2203-
"override-exposed": "Window Worker",
22042227
"properties": {
22052228
"property": {
22062229
"srcElement": {
2230+
"exposed": "Window",
22072231
"type": "Element",
2208-
"nullable": 1
2232+
"nullable": 1,
2233+
"deprecated": 1
22092234
}
22102235
}
22112236
}
@@ -2371,8 +2396,17 @@
23712396
"methods": {
23722397
"method": {
23732398
"reload": {
2374-
"override-signatures": [
2375-
"reload(forcedReload?: boolean): void"
2399+
"signature": [
2400+
{
2401+
"type": "void",
2402+
"param": [
2403+
{
2404+
"name": "forcedReload",
2405+
"type": "boolean"
2406+
}
2407+
],
2408+
"deprecated": 1
2409+
}
23762410
]
23772411
}
23782412
}

‎src/emitter.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,8 +327,6 @@ export function emitWebIDl(webidl: Browser.WebIdl, flavor: Flavor) {
327327
case "DOMTimeStamp": return "number";
328328
case "EventListener": return "EventListenerOrEventListenerObject";
329329
}
330-
if (flavor === Flavor.Web && objDomType === "Client") return "object";
331-
if (flavor === Flavor.Worker && objDomType === "Element") return "object";
332330
// Name of an interface / enum / dict. Just return itself
333331
if (allInterfacesMap[objDomType] ||
334332
allLegacyWindowAliases.includes(objDomType) ||
@@ -659,6 +657,7 @@ export function emitWebIDl(webidl: Browser.WebIdl, flavor: Flavor) {
659657
const paramsString = s.param ? paramsToString(s.param) : "";
660658
let returnType = convertDomTypeToTsType(s);
661659
returnType = s.nullable ? makeNullable(returnType) : returnType;
660+
emitComments(s, printLine);
662661
printLine(`${prefix || ""}${name || ""}(${paramsString}): ${returnType};`);
663662
}
664663

@@ -1043,13 +1042,13 @@ export function emitWebIDl(webidl: Browser.WebIdl, flavor: Flavor) {
10431042
}
10441043

10451044
function emitTypeDef(typeDef: Browser.TypeDef) {
1045+
emitComments(typeDef, printer.printLine);
10461046
printer.printLine(`type ${typeDef["new-type"]} = ${convertDomTypeToTsType(typeDef)};`);
10471047
}
10481048

10491049
function emitTypeDefs() {
10501050
if (webidl.typedefs) {
1051-
webidl.typedefs.typedef
1052-
.forEach(emitTypeDef);
1051+
webidl.typedefs.typedef.forEach(emitTypeDef);
10531052
}
10541053
}
10551054

‎src/types.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export interface Param extends Typed {
1616
export interface Signature extends Typed {
1717
param?: Param[];
1818
"param-min-required"?: number,
19+
"deprecated"?: 1
1920
}
2021

2122
export interface Member extends Typed {
@@ -203,6 +204,7 @@ export interface Enum {
203204

204205
export interface TypeDef extends Typed {
205206
"new-type": string;
207+
deprecated?: 1;
206208
}
207209

208210
export interface Dictionary {

0 commit comments

Comments
 (0)