Skip to content

Commit 34074aa

Browse files
HarshithaKPtargos
authored andcommitted
doc: clarify requireManualDestroy option
Fixes: #32409 PR-URL: #32514 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vladimir de Turckheim <[email protected]>
1 parent a1bb93a commit 34074aa

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/api/async_hooks.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -681,10 +681,10 @@ asyncResource.triggerAsyncId();
681681
* `options` {Object}
682682
* `triggerAsyncId` {number} The ID of the execution context that created this
683683
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.
688688
**Default:** `false`.
689689

690690
Example usage:

0 commit comments

Comments
 (0)