Skip to content

Commit f2235f6

Browse files
HarshithaKPtargos
authored andcommittedApr 22, 2020
doc: clarify requireManualDestroy option
Fixes: #32409 PR-URL: #32514 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
1 parent 7e952f2 commit f2235f6

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
@@ -625,10 +625,10 @@ asyncResource.triggerAsyncId();
625625
* `options` {Object}
626626
* `triggerAsyncId` {number} The ID of the execution context that created this
627627
async event. **Default:** `executionAsyncId()`.
628-
* `requireManualDestroy` {boolean} Disables automatic `emitDestroy` when the
629-
object is garbage collected. This usually does not need to be set (even if
630-
`emitDestroy` is called manually), unless the resource's `asyncId` is
631-
retrieved and the sensitive API's `emitDestroy` is called with it.
628+
* `requireManualDestroy` {boolean} If set to `true`, disables `emitDestroy`
629+
when the object is garbage collected. This usually does not need to be set
630+
(even if `emitDestroy` is called manually), unless the resource's `asyncId`
631+
is retrieved and the sensitive API's `emitDestroy` is called with it.
632632
**Default:** `false`.
633633

634634
Example usage:

0 commit comments

Comments
 (0)
Please sign in to comment.