chore(node): minor jsdoc improvements for global URL and URLSearchParams

DefinitelyTyped · Jan 20, 2022 · 3428cc4 · 3428cc4
1 parent 2f5747e
commit 3428cc4
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/types/node/url.d.ts b/types/node/url.d.ts
@@ -865,13 +865,13 @@ declare module 'url' {
             URLSearchParams: typeof _URLSearchParams;
         }
         /**
-         * `URL` class is global.
+         * `URL` class is a global reference for `require('url').URL`
          * https://nodejs.org/api/url.html#the-whatwg-url-api
          * @since v10.0.0
          */
         var URL: typeof globalThis extends { webkitURL: infer URL } ? URL : typeof _URL;
         /**
-         * `URLSearchParams` class is global.
+         * `URLSearchParams` class is global for `require('url').URLSearchParams`
          * https://nodejs.org/api/url.html#class-urlsearchparams
          * @since v10.0.0
          */

diff --git a/types/node/v12/url.d.ts b/types/node/v12/url.d.ts
@@ -124,13 +124,13 @@ declare module 'url' {
             URLSearchParams: typeof _URLSearchParams;
         }
         /**
-         * `URL` class is global.
+         * `URL` class is a global reference for `require('url').URL`
          * https://nodejs.org/api/url.html#the-whatwg-url-api
          * @since v10.0.0
          */
         var URL: typeof globalThis extends { webkitURL: infer URL } ? URL : typeof _URL;
         /**
-         * `URLSearchParams` class is global.
+         * `URLSearchParams` class is global for `require('url').URLSearchParams`.
          * https://nodejs.org/api/url.html#class-urlsearchparams
          * @since v10.0.0
          */

diff --git a/types/node/v14/url.d.ts b/types/node/v14/url.d.ts
@@ -123,13 +123,13 @@ declare module 'url' {
             URLSearchParams: typeof _URLSearchParams;
         }
         /**
-         * `URL` class is global.
+         * `URL` class is a global reference for `require('url').URL`
          * https://nodejs.org/api/url.html#the-whatwg-url-api
          * @since v10.0.0
          */
         var URL: typeof globalThis extends { webkitURL: infer URL } ? URL : typeof _URL;
         /**
-         * `URLSearchParams` class is global.
+         * `URLSearchParams` class is global for `require('url').URLSearchParams`.
          * https://nodejs.org/api/url.html#class-urlsearchparams
          * @since v10.0.0
          */

diff --git a/types/node/v16/url.d.ts b/types/node/v16/url.d.ts
@@ -825,13 +825,13 @@ declare module 'url' {
             URLSearchParams: typeof _URLSearchParams;
         }
         /**
-         * `URL` class is global.
+         * `URL` class is a global reference for `require('url').URL`
          * https://nodejs.org/api/url.html#the-whatwg-url-api
          * @since v10.0.0
          */
         var URL: typeof globalThis extends { webkitURL: infer URL } ? URL : typeof _URL;
         /**
-         * `URLSearchParams` class is global.
+         * `URLSearchParams` class is global for `require('url').URLSearchParams`.
          * https://nodejs.org/api/url.html#class-urlsearchparams
          * @since v10.0.0
          */