Skip to content

Commit 1268ed6

Browse files
lucacasonatosaschanaz
lucacasonato
and
saschanaz
authored
Consistently use Promise<void> instead of Promise<undefined> (microsoft#1598)
Co-authored-by: saschanaz <saschanaz@users.noreply.github.com>
1 parent 369d9c7 commit 1268ed6

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

‎baselines/audioworklet.generated.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@ declare var ReadableStreamDefaultReader: {
857857

858858
interface ReadableStreamGenericReader {
859859
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) */
860-
readonly closed: Promise<undefined>;
860+
readonly closed: Promise<void>;
861861
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) */
862862
cancel(reason?: any): Promise<void>;
863863
}
@@ -1152,11 +1152,11 @@ declare var WritableStreamDefaultController: {
11521152
*/
11531153
interface WritableStreamDefaultWriter<W = any> {
11541154
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) */
1155-
readonly closed: Promise<undefined>;
1155+
readonly closed: Promise<void>;
11561156
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) */
11571157
readonly desiredSize: number | null;
11581158
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */
1159-
readonly ready: Promise<undefined>;
1159+
readonly ready: Promise<void>;
11601160
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */
11611161
abort(reason?: any): Promise<void>;
11621162
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */

‎baselines/dom.generated.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19612,7 +19612,7 @@ declare var ReadableStreamDefaultReader: {
1961219612

1961319613
interface ReadableStreamGenericReader {
1961419614
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) */
19615-
readonly closed: Promise<undefined>;
19615+
readonly closed: Promise<void>;
1961619616
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) */
1961719617
cancel(reason?: any): Promise<void>;
1961819618
}
@@ -26745,7 +26745,7 @@ interface WebTransport {
2674526745
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/incomingUnidirectionalStreams) */
2674626746
readonly incomingUnidirectionalStreams: ReadableStream;
2674726747
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/ready) */
26748-
readonly ready: Promise<undefined>;
26748+
readonly ready: Promise<void>;
2674926749
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/close) */
2675026750
close(closeInfo?: WebTransportCloseInfo): void;
2675126751
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/createBidirectionalStream) */
@@ -27359,11 +27359,11 @@ declare var WritableStreamDefaultController: {
2735927359
*/
2736027360
interface WritableStreamDefaultWriter<W = any> {
2736127361
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) */
27362-
readonly closed: Promise<undefined>;
27362+
readonly closed: Promise<void>;
2736327363
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) */
2736427364
readonly desiredSize: number | null;
2736527365
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */
27366-
readonly ready: Promise<undefined>;
27366+
readonly ready: Promise<void>;
2736727367
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */
2736827368
abort(reason?: any): Promise<void>;
2736927369
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */

‎baselines/serviceworker.generated.d.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ interface ExtendableMessageEventInit extends ExtendableEventInit {
194194

195195
interface FetchEventInit extends ExtendableEventInit {
196196
clientId?: string;
197-
handled?: Promise<undefined>;
197+
handled?: Promise<void>;
198198
preloadResponse?: Promise<any>;
199199
replacesClientId?: string;
200200
request: Request;
@@ -2517,7 +2517,7 @@ interface FetchEvent extends ExtendableEvent {
25172517
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/clientId) */
25182518
readonly clientId: string;
25192519
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/handled) */
2520-
readonly handled: Promise<undefined>;
2520+
readonly handled: Promise<void>;
25212521
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/preloadResponse) */
25222522
readonly preloadResponse: Promise<any>;
25232523
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/request) */
@@ -4652,7 +4652,7 @@ declare var ReadableStreamDefaultReader: {
46524652

46534653
interface ReadableStreamGenericReader {
46544654
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) */
4655-
readonly closed: Promise<undefined>;
4655+
readonly closed: Promise<void>;
46564656
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) */
46574657
cancel(reason?: any): Promise<void>;
46584658
}
@@ -7910,7 +7910,7 @@ interface WebTransport {
79107910
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/incomingUnidirectionalStreams) */
79117911
readonly incomingUnidirectionalStreams: ReadableStream;
79127912
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/ready) */
7913-
readonly ready: Promise<undefined>;
7913+
readonly ready: Promise<void>;
79147914
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/close) */
79157915
close(closeInfo?: WebTransportCloseInfo): void;
79167916
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/createBidirectionalStream) */
@@ -8212,11 +8212,11 @@ declare var WritableStreamDefaultController: {
82128212
*/
82138213
interface WritableStreamDefaultWriter<W = any> {
82148214
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) */
8215-
readonly closed: Promise<undefined>;
8215+
readonly closed: Promise<void>;
82168216
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) */
82178217
readonly desiredSize: number | null;
82188218
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */
8219-
readonly ready: Promise<undefined>;
8219+
readonly ready: Promise<void>;
82208220
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */
82218221
abort(reason?: any): Promise<void>;
82228222
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */

‎baselines/sharedworker.generated.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4484,7 +4484,7 @@ declare var ReadableStreamDefaultReader: {
44844484

44854485
interface ReadableStreamGenericReader {
44864486
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) */
4487-
readonly closed: Promise<undefined>;
4487+
readonly closed: Promise<void>;
44884488
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) */
44894489
cancel(reason?: any): Promise<void>;
44904490
}
@@ -7721,7 +7721,7 @@ interface WebTransport {
77217721
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/incomingUnidirectionalStreams) */
77227722
readonly incomingUnidirectionalStreams: ReadableStream;
77237723
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/ready) */
7724-
readonly ready: Promise<undefined>;
7724+
readonly ready: Promise<void>;
77257725
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/close) */
77267726
close(closeInfo?: WebTransportCloseInfo): void;
77277727
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/createBidirectionalStream) */
@@ -8035,11 +8035,11 @@ declare var WritableStreamDefaultController: {
80358035
*/
80368036
interface WritableStreamDefaultWriter<W = any> {
80378037
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) */
8038-
readonly closed: Promise<undefined>;
8038+
readonly closed: Promise<void>;
80398039
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) */
80408040
readonly desiredSize: number | null;
80418041
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */
8042-
readonly ready: Promise<undefined>;
8042+
readonly ready: Promise<void>;
80438043
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */
80448044
abort(reason?: any): Promise<void>;
80458045
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */

‎baselines/webworker.generated.d.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ interface ExtendableMessageEventInit extends ExtendableEventInit {
274274

275275
interface FetchEventInit extends ExtendableEventInit {
276276
clientId?: string;
277-
handled?: Promise<undefined>;
277+
handled?: Promise<void>;
278278
preloadResponse?: Promise<any>;
279279
replacesClientId?: string;
280280
request: Request;
@@ -2955,7 +2955,7 @@ interface FetchEvent extends ExtendableEvent {
29552955
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/clientId) */
29562956
readonly clientId: string;
29572957
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/handled) */
2958-
readonly handled: Promise<undefined>;
2958+
readonly handled: Promise<void>;
29592959
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/preloadResponse) */
29602960
readonly preloadResponse: Promise<any>;
29612961
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/request) */
@@ -5351,7 +5351,7 @@ declare var ReadableStreamDefaultReader: {
53515351

53525352
interface ReadableStreamGenericReader {
53535353
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) */
5354-
readonly closed: Promise<undefined>;
5354+
readonly closed: Promise<void>;
53555355
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) */
53565356
cancel(reason?: any): Promise<void>;
53575357
}
@@ -8779,7 +8779,7 @@ interface WebTransport {
87798779
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/incomingUnidirectionalStreams) */
87808780
readonly incomingUnidirectionalStreams: ReadableStream;
87818781
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/ready) */
8782-
readonly ready: Promise<undefined>;
8782+
readonly ready: Promise<void>;
87838783
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/close) */
87848784
close(closeInfo?: WebTransportCloseInfo): void;
87858785
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebTransport/createBidirectionalStream) */
@@ -9114,11 +9114,11 @@ declare var WritableStreamDefaultController: {
91149114
*/
91159115
interface WritableStreamDefaultWriter<W = any> {
91169116
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) */
9117-
readonly closed: Promise<undefined>;
9117+
readonly closed: Promise<void>;
91189118
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) */
91199119
readonly desiredSize: number | null;
91209120
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */
9121-
readonly ready: Promise<undefined>;
9121+
readonly ready: Promise<void>;
91229122
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */
91239123
abort(reason?: any): Promise<void>;
91249124
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */

‎src/build/emitter.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,10 @@ export function emitWebIdl(
358358
}
359359
if (!obj.type)
360360
throw new Error("Missing 'type' field in " + JSON.stringify(obj));
361-
const type = convertDomTypeToTsTypeWorker(obj);
361+
let type = convertDomTypeToTsTypeWorker(obj);
362+
if (type === "Promise<undefined>") {
363+
type = "Promise<void>";
364+
}
362365
return obj.nullable ? makeNullable(type) : type;
363366
}
364367

@@ -367,9 +370,6 @@ export function emitWebIdl(
367370
if (type === "undefined") {
368371
return "void";
369372
}
370-
if (type === "Promise<undefined>") {
371-
return "Promise<void>";
372-
}
373373
if (type === "undefined | PromiseLike<undefined>") {
374374
return "void | PromiseLike<void>";
375375
}

0 commit comments

Comments
 (0)