doc: update output of example in AbortController

Actual output of example in AbortController is mismatched. Plus, make `reason` parameter as optional in JSDoc. Refs: https://github.com/nodejs/node/blob/main/doc/api/globals.md#abortcontrollerabortreason Refs: https://github.com/nodejs/node/blob/main/doc/api/globals.md#static-method-abortsignalabortreason PR-URL: #47227 Reviewed-By: Debadree Chatterjee <[email protected]> Reviewed-By: Erick Wendel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Apr 7, 2023 · a21459e · a21459e
1 parent 22b9acd
commit a21459e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -43,7 +43,7 @@ ac.signal.addEventListener('abort', () => console.log('Aborted!'),
 
 ac.abort();
 
-console.log(ac.signal.aborted);  // Prints True
+console.log(ac.signal.aborted);  // Prints true
 ```
 
 ### `abortController.abort([reason])`
@@ -196,7 +196,7 @@ An optional reason specified when the `AbortSignal` was triggered.
 ```js
 const ac = new AbortController();
 ac.abort(new Error('boom!'));
-console.log(ac.signal.reason);  // Error('boom!');
+console.log(ac.signal.reason);  // Error: boom!
 ```
 
 #### `abortSignal.throwIfAborted()`

diff --git a/lib/internal/abort_controller.js b/lib/internal/abort_controller.js
@@ -163,7 +163,7 @@ class AbortSignal extends EventTarget {
   }
 
   /**
-   * @param {any} reason
+   * @param {any} [reason]
    * @returns {AbortSignal}
    */
   static abort(
@@ -326,7 +326,7 @@ class AbortController {
   }
 
   /**
-   * @param {any} reason
+   * @param {any} [reason]
    */
   abort(reason = new DOMException('This operation was aborted', 'AbortError')) {
     abortSignal(this.#signal ??= createAbortSignal(), reason);