feat(node): declare URL and URLSearchParams as globals

closes: DefinitelyTyped#34960
antongolub-forks · Jan 20, 2022 · 28295cf · 28295cf
1 parent 721dbc0
commit 28295cf
Show file tree

Hide file tree

Showing 15 changed files with 71 additions and 4 deletions.
diff --git a/types/node/index.d.ts b/types/node/index.d.ts
@@ -120,6 +120,7 @@
 /// <reference path="trace_events.d.ts" />
 /// <reference path="tty.d.ts" />
 /// <reference path="url.d.ts" />
+/// <reference path="url.globals.d.ts" />
 /// <reference path="util.d.ts" />
 /// <reference path="v8.d.ts" />
 /// <reference path="vm.d.ts" />

diff --git a/types/node/test/url.ts b/types/node/test/url.ts
@@ -167,3 +167,9 @@ import * as url from 'node:url';
 {
     const dataUrl: string = url.URL.createObjectURL(new Blob(['']));
 }
+{
+    const dataUrl1: URL = new url.URL('file://test');
+    const dataUrl2: url.URL = new URL('file://test');
+    const urlSearchParams1: URLSearchParams = new url.URLSearchParams();
+    const urlSearchParams2: url.URLSearchParams = new URLSearchParams();
+}
diff --git a/types/node/url.d.ts b/types/node/url.d.ts
@@ -778,7 +778,7 @@ declare module 'url' {
          * @param fn Invoked for each name-value pair in the query
          * @param thisArg To be used as `this` value for when `fn` is called
          */
-        forEach<TThis = this>(callback: (this: TThis, value: string, name: string, searchParams: this) => void, thisArg?: TThis): void;
+        forEach<TThis = this>(callback: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void, thisArg?: TThis): void;
         /**
          * Returns the value of the first name-value pair whose name is `name`. If there
          * are no such pairs, `null` is returned.

diff --git a/types/node/url.globals.d.ts b/types/node/url.globals.d.ts
@@ -0,0 +1,11 @@
+import { URL as _URL, URLSearchParams as _URLSearchParams } from 'url';
+
+declare global {
+    interface Global {
+        URL: typeof _URL;
+        URLSearchParams: typeof _URLSearchParams;
+    }
+
+    interface URLSearchParams extends _URLSearchParams {}
+    interface URL extends _URL {}
+}
diff --git a/types/node/v12/index.d.ts b/types/node/v12/index.d.ts
@@ -82,6 +82,7 @@
 /// <reference path="trace_events.d.ts" />
 /// <reference path="tty.d.ts" />
 /// <reference path="url.d.ts" />
+/// <reference path="url.globals.d.ts" />
 /// <reference path="util.d.ts" />
 /// <reference path="v8.d.ts" />
 /// <reference path="vm.d.ts" />

diff --git a/types/node/v12/url.d.ts b/types/node/v12/url.d.ts
@@ -103,7 +103,7 @@ declare module 'url' {
         append(name: string, value: string): void;
         delete(name: string): void;
         entries(): IterableIterator<[string, string]>;
-        forEach(callback: (value: string, name: string, searchParams: this) => void): void;
+        forEach(callback: (value: string, name: string, searchParams: URLSearchParams) => void): void;
         get(name: string): string | null;
         getAll(name: string): string[];
         has(name: string): boolean;

diff --git a/types/node/v12/url.globals.d.ts b/types/node/v12/url.globals.d.ts
@@ -0,0 +1,11 @@
+import { URL as _URL, URLSearchParams as _URLSearchParams } from 'url';
+
+declare global {
+    interface Global {
+        URL: typeof _URL;
+        URLSearchParams: typeof _URLSearchParams;
+    }
+
+    interface URLSearchParams extends _URLSearchParams {}
+    interface URL extends _URL {}
+}
diff --git a/types/node/v14/index.d.ts b/types/node/v14/index.d.ts
@@ -88,6 +88,7 @@
 /// <reference path="trace_events.d.ts" />
 /// <reference path="tty.d.ts" />
 /// <reference path="url.d.ts" />
+/// <reference path="url.globals.d.ts" />
 /// <reference path="util.d.ts" />
 /// <reference path="v8.d.ts" />
 /// <reference path="vm.d.ts" />

diff --git a/types/node/v14/test/url.ts b/types/node/v14/test/url.ts
@@ -154,3 +154,10 @@ import * as url from 'node:url';
 {
     const path: url.URL = url.pathToFileURL('file://test');
 }
+
+{
+    const dataUrl1: URL = new url.URL('file://test');
+    const dataUrl2: url.URL = new URL('file://test');
+    const urlSearchParams1: URLSearchParams = new url.URLSearchParams();
+    const urlSearchParams2: url.URLSearchParams = new URLSearchParams();
+}
diff --git a/types/node/v14/url.d.ts b/types/node/v14/url.d.ts
@@ -102,7 +102,7 @@ declare module 'url' {
         append(name: string, value: string): void;
         delete(name: string): void;
         entries(): IterableIterator<[string, string]>;
-        forEach(callback: (value: string, name: string, searchParams: this) => void): void;
+        forEach(callback: (value: string, name: string, searchParams: URLSearchParams) => void, thisArg?: any): void;
         get(name: string): string | null;
         getAll(name: string): string[];
         has(name: string): boolean;

diff --git a/types/node/v14/url.globals.d.ts b/types/node/v14/url.globals.d.ts
@@ -0,0 +1,11 @@
+import { URL as _URL, URLSearchParams as _URLSearchParams } from 'node:url';
+
+declare global {
+    interface Global {
+        URL: typeof _URL;
+        URLSearchParams: typeof _URLSearchParams;
+    }
+
+    interface URLSearchParams extends _URLSearchParams {}
+    interface URL extends _URL {}
+}
diff --git a/types/node/v16/index.d.ts b/types/node/v16/index.d.ts
@@ -120,6 +120,7 @@
 /// <reference path="trace_events.d.ts" />
 /// <reference path="tty.d.ts" />
 /// <reference path="url.d.ts" />
+/// <reference path="url.globals.d.ts" />
 /// <reference path="util.d.ts" />
 /// <reference path="v8.d.ts" />
 /// <reference path="vm.d.ts" />

diff --git a/types/node/v16/test/url.ts b/types/node/v16/test/url.ts
@@ -167,3 +167,9 @@ import * as url from 'node:url';
 {
     const dataUrl: string = url.URL.createObjectURL(new Blob(['']));
 }
+{
+    const dataUrl1: URL = new url.URL('file://test');
+    const dataUrl2: url.URL = new URL('file://test');
+    const urlSearchParams1: URLSearchParams = new url.URLSearchParams();
+    const urlSearchParams2: url.URLSearchParams = new URLSearchParams();
+}
diff --git a/types/node/v16/url.d.ts b/types/node/v16/url.d.ts
@@ -738,7 +738,7 @@ declare module 'url' {
          * @param fn Invoked for each name-value pair in the query
          * @param thisArg To be used as `this` value for when `fn` is called
          */
-        forEach<TThis = this>(callback: (this: TThis, value: string, name: string, searchParams: this) => void, thisArg?: TThis): void;
+        forEach<TThis = this>(callback: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void, thisArg?: TThis): void;
         /**
          * Returns the value of the first name-value pair whose name is `name`. If there
          * are no such pairs, `null` is returned.

diff --git a/types/node/v16/url.globals.d.ts b/types/node/v16/url.globals.d.ts
@@ -0,0 +1,11 @@
+import { URL as _URL, URLSearchParams as _URLSearchParams } from 'url';
+
+declare global {
+    interface Global {
+        URL: typeof _URL;
+        URLSearchParams: typeof _URLSearchParams;
+    }
+
+    interface URLSearchParams extends _URLSearchParams {}
+    interface URL extends _URL {}
+}