Skip to content

Commit 6ed64e7

Browse files
committed
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 <debadree333@gmail.com> Reviewed-By: Erick Wendel <erick.workspace@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 06c91af commit 6ed64e7

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/api/globals.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ ac.signal.addEventListener('abort', () => console.log('Aborted!'),
4343

4444
ac.abort();
4545

46-
console.log(ac.signal.aborted); // Prints True
46+
console.log(ac.signal.aborted); // Prints true
4747
```
4848

4949
### `abortController.abort([reason])`
@@ -196,7 +196,7 @@ An optional reason specified when the `AbortSignal` was triggered.
196196
```js
197197
const ac = new AbortController();
198198
ac.abort(new Error('boom!'));
199-
console.log(ac.signal.reason); // Error('boom!');
199+
console.log(ac.signal.reason); // Error: boom!
200200
```
201201

202202
#### `abortSignal.throwIfAborted()`

lib/internal/abort_controller.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ class AbortSignal extends EventTarget {
163163
}
164164

165165
/**
166-
* @param {any} reason
166+
* @param {any} [reason]
167167
* @returns {AbortSignal}
168168
*/
169169
static abort(
@@ -326,7 +326,7 @@ class AbortController {
326326
}
327327

328328
/**
329-
* @param {any} reason
329+
* @param {any} [reason]
330330
*/
331331
abort(reason = new DOMException('This operation was aborted', 'AbortError')) {
332332
abortSignal(this.#signal ??= createAbortSignal(), reason);

0 commit comments

Comments
 (0)