Skip to content

Commit 8139c3c

Browse files
committed
Experiment: Convert Promise<void> to Promise<undefined>
As suggested in microsoft/TypeScript-DOM-lib-generator#1598
1 parent 2623fe7 commit 8139c3c

File tree

6 files changed

+93
-93
lines changed

6 files changed

+93
-93
lines changed

src/lib/dom.generated.d.ts

Lines changed: 62 additions & 62 deletions
Large diffs are not rendered by default.

src/lib/dom.iterable.generated.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface CSSUnparsedValue {
5252

5353
interface Cache {
5454
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll) */
55-
addAll(requests: Iterable<RequestInfo>): Promise<void>;
55+
addAll(requests: Iterable<RequestInfo>): Promise<undefined>;
5656
}
5757

5858
interface CanvasPath {

src/lib/es2015.promise.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ interface PromiseConstructor {
4545
* Creates a new resolved promise.
4646
* @returns A resolved promise.
4747
*/
48-
resolve(): Promise<void>;
48+
resolve(): Promise<undefined>;
4949
/**
5050
* Creates a new resolved promise for the provided value.
5151
* @param value A promise.

src/lib/esnext.disposable.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ interface AsyncDisposableStack {
107107
/**
108108
* Disposes each resource in the stack in the reverse order that they were added.
109109
*/
110-
disposeAsync(): Promise<void>;
110+
disposeAsync(): Promise<undefined>;
111111
/**
112112
* Adds a disposable resource to the stack, returning the resource.
113113
* @param value The resource to add. `null` and `undefined` will not be added, but will be returned.
@@ -156,7 +156,7 @@ interface AsyncDisposableStack {
156156
* ```
157157
*/
158158
move(): AsyncDisposableStack;
159-
[Symbol.asyncDispose](): Promise<void>;
159+
[Symbol.asyncDispose](): Promise<undefined>;
160160
readonly [Symbol.toStringTag]: string;
161161
}
162162

src/lib/webworker.generated.d.ts

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,9 +1423,9 @@ declare var CSSVariableReferenceValue: {
14231423
*/
14241424
interface Cache {
14251425
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/add) */
1426-
add(request: RequestInfo | URL): Promise<void>;
1426+
add(request: RequestInfo | URL): Promise<undefined>;
14271427
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll) */
1428-
addAll(requests: RequestInfo[]): Promise<void>;
1428+
addAll(requests: RequestInfo[]): Promise<undefined>;
14291429
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/delete) */
14301430
delete(request: RequestInfo | URL, options?: CacheQueryOptions): Promise<boolean>;
14311431
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/keys) */
@@ -1435,7 +1435,7 @@ interface Cache {
14351435
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/matchAll) */
14361436
matchAll(request?: RequestInfo | URL, options?: CacheQueryOptions): Promise<ReadonlyArray<Response>>;
14371437
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/put) */
1438-
put(request: RequestInfo | URL, response: Response): Promise<void>;
1438+
put(request: RequestInfo | URL, response: Response): Promise<undefined>;
14391439
}
14401440

14411441
declare var Cache: {
@@ -1719,7 +1719,7 @@ declare var Client: {
17191719
*/
17201720
interface Clients {
17211721
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clients/claim) */
1722-
claim(): Promise<void>;
1722+
claim(): Promise<undefined>;
17231723
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clients/get) */
17241724
get(id: string): Promise<Client | undefined>;
17251725
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Clients/matchAll) */
@@ -2825,7 +2825,7 @@ interface FileSystemDirectoryHandle extends FileSystemHandle {
28252825
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/getFileHandle) */
28262826
getFileHandle(name: string, options?: FileSystemGetFileOptions): Promise<FileSystemFileHandle>;
28272827
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/removeEntry) */
2828-
removeEntry(name: string, options?: FileSystemRemoveOptions): Promise<void>;
2828+
removeEntry(name: string, options?: FileSystemRemoveOptions): Promise<undefined>;
28292829
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle/resolve) */
28302830
resolve(possibleDescendant: FileSystemHandle): Promise<string[] | null>;
28312831
}
@@ -2906,11 +2906,11 @@ declare var FileSystemSyncAccessHandle: {
29062906
*/
29072907
interface FileSystemWritableFileStream extends WritableStream {
29082908
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/seek) */
2909-
seek(position: number): Promise<void>;
2909+
seek(position: number): Promise<undefined>;
29102910
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/truncate) */
2911-
truncate(size: number): Promise<void>;
2911+
truncate(size: number): Promise<undefined>;
29122912
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileSystemWritableFileStream/write) */
2913-
write(data: FileSystemWriteChunkType): Promise<void>;
2913+
write(data: FileSystemWriteChunkType): Promise<undefined>;
29142914
}
29152915

29162916
declare var FileSystemWritableFileStream: {
@@ -4005,13 +4005,13 @@ declare var MessagePort: {
40054005
*/
40064006
interface NavigationPreloadManager {
40074007
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/NavigationPreloadManager/disable) */
4008-
disable(): Promise<void>;
4008+
disable(): Promise<undefined>;
40094009
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/NavigationPreloadManager/enable) */
4010-
enable(): Promise<void>;
4010+
enable(): Promise<undefined>;
40114011
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/NavigationPreloadManager/getState) */
40124012
getState(): Promise<NavigationPreloadState>;
40134013
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/NavigationPreloadManager/setHeaderValue) */
4014-
setHeaderValue(value: string): Promise<void>;
4014+
setHeaderValue(value: string): Promise<undefined>;
40154015
}
40164016

40174017
declare var NavigationPreloadManager: {
@@ -4022,9 +4022,9 @@ declare var NavigationPreloadManager: {
40224022
/** Available only in secure contexts. */
40234023
interface NavigatorBadge {
40244024
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/clearAppBadge) */
4025-
clearAppBadge(): Promise<void>;
4025+
clearAppBadge(): Promise<undefined>;
40264026
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/setAppBadge) */
4027-
setAppBadge(contents?: number): Promise<void>;
4027+
setAppBadge(contents?: number): Promise<undefined>;
40284028
}
40294029

40304030
interface NavigatorConcurrentHardware {
@@ -4771,15 +4771,15 @@ interface ReadableStream<R = any> {
47714771
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/locked) */
47724772
readonly locked: boolean;
47734773
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) */
4774-
cancel(reason?: any): Promise<void>;
4774+
cancel(reason?: any): Promise<undefined>;
47754775
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) */
47764776
getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
47774777
getReader(): ReadableStreamDefaultReader<R>;
47784778
getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>;
47794779
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) */
47804780
pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>;
47814781
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) */
4782-
pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>;
4782+
pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<undefined>;
47834783
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) */
47844784
tee(): [ReadableStream<R>, ReadableStream<R>];
47854785
}
@@ -4853,7 +4853,7 @@ interface ReadableStreamGenericReader {
48534853
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) */
48544854
readonly closed: Promise<undefined>;
48554855
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) */
4856-
cancel(reason?: any): Promise<void>;
4856+
cancel(reason?: any): Promise<undefined>;
48574857
}
48584858

48594859
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Report) */
@@ -5176,7 +5176,7 @@ interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
51765176
readonly registration: ServiceWorkerRegistration;
51775177
readonly serviceWorker: ServiceWorker;
51785178
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerGlobalScope/skipWaiting) */
5179-
skipWaiting(): Promise<void>;
5179+
skipWaiting(): Promise<undefined>;
51805180
addEventListener<K extends keyof ServiceWorkerGlobalScopeEventMap>(type: K, listener: (this: ServiceWorkerGlobalScope, ev: ServiceWorkerGlobalScopeEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
51815181
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
51825182
removeEventListener<K extends keyof ServiceWorkerGlobalScopeEventMap>(type: K, listener: (this: ServiceWorkerGlobalScope, ev: ServiceWorkerGlobalScopeEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
@@ -5218,11 +5218,11 @@ interface ServiceWorkerRegistration extends EventTarget {
52185218
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerRegistration/getNotifications) */
52195219
getNotifications(filter?: GetNotificationOptions): Promise<Notification[]>;
52205220
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerRegistration/showNotification) */
5221-
showNotification(title: string, options?: NotificationOptions): Promise<void>;
5221+
showNotification(title: string, options?: NotificationOptions): Promise<undefined>;
52225222
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerRegistration/unregister) */
52235223
unregister(): Promise<boolean>;
52245224
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerRegistration/update) */
5225-
update(): Promise<void>;
5225+
update(): Promise<undefined>;
52265226
addEventListener<K extends keyof ServiceWorkerRegistrationEventMap>(type: K, listener: (this: ServiceWorkerRegistration, ev: ServiceWorkerRegistrationEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
52275227
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
52285228
removeEventListener<K extends keyof ServiceWorkerRegistrationEventMap>(type: K, listener: (this: ServiceWorkerRegistration, ev: ServiceWorkerRegistrationEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
@@ -5674,7 +5674,7 @@ interface VideoDecoder extends EventTarget {
56745674
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/VideoDecoder/decode) */
56755675
decode(chunk: EncodedVideoChunk): void;
56765676
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/VideoDecoder/flush) */
5677-
flush(): Promise<void>;
5677+
flush(): Promise<undefined>;
56785678
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/VideoDecoder/reset) */
56795679
reset(): void;
56805680
addEventListener<K extends keyof VideoDecoderEventMap>(type: K, listener: (this: VideoDecoder, ev: VideoDecoderEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -5710,7 +5710,7 @@ interface VideoEncoder extends EventTarget {
57105710
configure(config: VideoEncoderConfig): void;
57115711
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/VideoEncoder/encode) */
57125712
encode(frame: VideoFrame, options?: VideoEncoderEncodeOptions): void;
5713-
flush(): Promise<void>;
5713+
flush(): Promise<undefined>;
57145714
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/VideoEncoder/reset) */
57155715
reset(): void;
57165716
addEventListener<K extends keyof VideoEncoderEventMap>(type: K, listener: (this: VideoEncoder, ev: VideoEncoderEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -8527,9 +8527,9 @@ interface WritableStream<W = any> {
85278527
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) */
85288528
readonly locked: boolean;
85298529
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) */
8530-
abort(reason?: any): Promise<void>;
8530+
abort(reason?: any): Promise<undefined>;
85318531
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) */
8532-
close(): Promise<void>;
8532+
close(): Promise<undefined>;
85338533
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) */
85348534
getWriter(): WritableStreamDefaultWriter<W>;
85358535
}
@@ -8569,13 +8569,13 @@ interface WritableStreamDefaultWriter<W = any> {
85698569
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) */
85708570
readonly ready: Promise<undefined>;
85718571
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) */
8572-
abort(reason?: any): Promise<void>;
8572+
abort(reason?: any): Promise<undefined>;
85738573
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) */
8574-
close(): Promise<void>;
8574+
close(): Promise<undefined>;
85758575
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) */
85768576
releaseLock(): void;
85778577
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) */
8578-
write(chunk?: W): Promise<void>;
8578+
write(chunk?: W): Promise<undefined>;
85798579
}
85808580

85818581
declare var WritableStreamDefaultWriter: {

src/lib/webworker.iterable.generated.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ interface CSSUnparsedValue {
2525

2626
interface Cache {
2727
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll) */
28-
addAll(requests: Iterable<RequestInfo>): Promise<void>;
28+
addAll(requests: Iterable<RequestInfo>): Promise<undefined>;
2929
}
3030

3131
interface CanvasPath {

0 commit comments

Comments
 (0)