🤖 Merge PR DefinitelyTyped#60055 [node] Improve consistency of JSDoc …

…since tags by @josh- * Update consistency of since tags in node * Fix typo
bjubes · Apr 26, 2022 · ecdd55d · ecdd55d
1 parent 1ca333e
commit ecdd55d
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 18 deletions.
diff --git a/types/node/async_hooks.d.ts b/types/node/async_hooks.d.ts
@@ -258,7 +258,7 @@ declare module 'async_hooks' {
          * @param type The type of async event.
          * @param triggerAsyncId The ID of the execution context that created
          *   this async event (default: `executionAsyncId()`), or an
-         *   AsyncResourceOptions object (since 9.3)
+         *   AsyncResourceOptions object (since v9.3.0)
          */
         constructor(type: string, triggerAsyncId?: number | AsyncResourceOptions);
         /**

diff --git a/types/node/globals.d.ts b/types/node/globals.d.ts
@@ -272,11 +272,11 @@ declare namespace NodeJS {
         id: string;
         filename: string;
         loaded: boolean;
-        /** @deprecated since 14.6.0 Please use `require.main` and `module.children` instead. */
+        /** @deprecated since v14.6.0 Please use `require.main` and `module.children` instead. */
         parent: Module | null | undefined;
         children: Module[];
         /**
-         * @since 11.14.0
+         * @since v11.14.0
          *
          * The directory name of the module. This is usually the same as the path.dirname() of the module.id.
          */

diff --git a/types/node/v12/async_hooks.d.ts b/types/node/v12/async_hooks.d.ts
@@ -111,7 +111,7 @@ declare module 'async_hooks' {
          * @param type The type of async event.
          * @param triggerAsyncId The ID of the execution context that created
          *   this async event (default: `executionAsyncId()`), or an
-         *   AsyncResourceOptions object (since 9.3)
+         *   AsyncResourceOptions object (since v9.3.0)
          */
         constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions);
 

diff --git a/types/node/v12/globals.d.ts b/types/node/v12/globals.d.ts
@@ -230,11 +230,11 @@ interface NodeModule {
     id: string;
     filename: string;
     loaded: boolean;
-    /** @deprecated since 12.19.0 Please use `require.main` and `module.children` instead. */
+    /** @deprecated since v12.19.0 Please use `require.main` and `module.children` instead. */
     parent: NodeModule | null | undefined;
     children: NodeModule[];
     /**
-     * @since 11.14.0
+     * @since v11.14.0
      *
      * The directory name of the module. This is usually the same as the path.dirname() of the module.id.
      */
@@ -1317,11 +1317,11 @@ declare namespace NodeJS {
         id: string;
         filename: string;
         loaded: boolean;
-        /** @deprecated since 12.19.0 Please use `require.main` and `module.children` instead. */
+        /** @deprecated since v12.19.0 Please use `require.main` and `module.children` instead. */
         parent: Module | null | undefined;
         children: Module[];
         /**
-         * @since 11.14.0
+         * @since v11.14.0
          *
          * The directory name of the module. This is usually the same as the path.dirname() of the module.id.
          */

diff --git a/types/node/v12/index.d.ts b/types/node/v12/index.d.ts
@@ -39,7 +39,7 @@
 
 // NOTE: These definitions support NodeJS and TypeScript 3.7.
 // This isn't strictly needed since 3.7 has the assert module, but this way we're consistent.
-// Typically type modificatons should be made in base.d.ts instead of here
+// Typically type modifications should be made in base.d.ts instead of here
 
 // Reference required types from the default lib:
 /// <reference lib="es2018" />

diff --git a/types/node/v12/inspector.d.ts b/types/node/v12/inspector.d.ts
@@ -1917,7 +1917,7 @@ declare module 'inspector' {
          * Connects a session to the main thread inspector back-end.
          * An exception will be thrown if this API was not called on a Worker
          * thread.
-         * @since 12.11.0
+         * @since v12.11.0
          */
         connectToMainThread(): void;
 

diff --git a/types/node/v14/async_hooks.d.ts b/types/node/v14/async_hooks.d.ts
@@ -111,7 +111,7 @@ declare module 'async_hooks' {
          * @param type The type of async event.
          * @param triggerAsyncId The ID of the execution context that created
          *   this async event (default: `executionAsyncId()`), or an
-         *   AsyncResourceOptions object (since 9.3)
+         *   AsyncResourceOptions object (since v9.3.0)
          */
         constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions);
 

diff --git a/types/node/v14/globals.d.ts b/types/node/v14/globals.d.ts
@@ -724,11 +724,11 @@ declare namespace NodeJS {
         id: string;
         filename: string;
         loaded: boolean;
-        /** @deprecated since 14.6.0 Please use `require.main` and `module.children` instead. */
+        /** @deprecated since v14.6.0 Please use `require.main` and `module.children` instead. */
         parent: Module | null | undefined;
         children: Module[];
         /**
-         * @since 11.14.0
+         * @since v11.14.0
          *
          * The directory name of the module. This is usually the same as the path.dirname() of the module.id.
          */

diff --git a/types/node/v14/inspector.d.ts b/types/node/v14/inspector.d.ts
@@ -1917,7 +1917,7 @@ declare module 'inspector' {
          * Connects a session to the main thread inspector back-end.
          * An exception will be thrown if this API was not called on a Worker
          * thread.
-         * @since 12.11.0
+         * @since v12.11.0
          */
         connectToMainThread(): void;
 

diff --git a/types/node/v16/async_hooks.d.ts b/types/node/v16/async_hooks.d.ts
@@ -258,7 +258,7 @@ declare module 'async_hooks' {
          * @param type The type of async event.
          * @param triggerAsyncId The ID of the execution context that created
          *   this async event (default: `executionAsyncId()`), or an
-         *   AsyncResourceOptions object (since 9.3)
+         *   AsyncResourceOptions object (since v9.3.0)
          */
         constructor(type: string, triggerAsyncId?: number | AsyncResourceOptions);
         /**

diff --git a/types/node/v16/globals.d.ts b/types/node/v16/globals.d.ts
@@ -262,11 +262,11 @@ declare namespace NodeJS {
         id: string;
         filename: string;
         loaded: boolean;
-        /** @deprecated since 14.6.0 Please use `require.main` and `module.children` instead. */
+        /** @deprecated since v14.6.0 Please use `require.main` and `module.children` instead. */
         parent: Module | null | undefined;
         children: Module[];
         /**
-         * @since 11.14.0
+         * @since v11.14.0
          *
          * The directory name of the module. This is usually the same as the path.dirname() of the module.id.
          */

diff --git a/types/node/v16/inspector.d.ts b/types/node/v16/inspector.d.ts
@@ -1782,7 +1782,7 @@ declare module 'inspector' {
          * Connects a session to the main thread inspector back-end.
          * An exception will be thrown if this API was not called on a Worker
          * thread.
-         * @since 12.11.0
+         * @since v12.11.0
          */
         connectToMainThread(): void;
         /**