GeezerVison is showing github.com — doc: clarify `requireManualDestroy` option · nodejs/node@34074aa
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/async_hooks.md +4-4Lines changed: 4 additions & 4 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -681,10 +681,10 @@ asyncResource.triggerAsyncId(); |
681 | 681 | * `options` {Object} |
682 | 682 | * `triggerAsyncId` {number} The ID of the execution context that created this |
683 | 683 | async event. **Default:** `executionAsyncId()`. |
684 | | - * `requireManualDestroy` {boolean} Disables automatic `emitDestroy` when the |
685 | | - object is garbage collected. This usually does not need to be set (even if |
686 | | - `emitDestroy` is called manually), unless the resource's `asyncId` is |
687 | | - retrieved and the sensitive API's `emitDestroy` is called with it. |
| 684 | + * `requireManualDestroy` {boolean} If set to `true`, disables `emitDestroy` |
| 685 | + when the object is garbage collected. This usually does not need to be set |
| 686 | + (even if `emitDestroy` is called manually), unless the resource's `asyncId` |
| 687 | + is retrieved and the sensitive API's `emitDestroy` is called with it. |
688 | 688 | **Default:** `false`. |
689 | 689 |
|
690 | 690 | Example usage: |
|