From a21459e0d50fb2de31b301c2b7d72014b9929ad4 Mon Sep 17 00:00:00 2001 From: Deokjin Kim Date: Thu, 23 Mar 2023 00:50:41 +0900 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/47227 Reviewed-By: Debadree Chatterjee Reviewed-By: Erick Wendel Reviewed-By: Luigi Pinca --- doc/api/globals.md | 4 ++-- lib/internal/abort_controller.js | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/globals.md b/doc/api/globals.md index ec42fd53ab24eb..a9a6348264acb8 100644 --- 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 index 847d9db6699d75..2c1f43354f9f7c 100644 --- 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);