Skip to content

Commit

Permalink
doc: clarify requireManualDestroy option
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
HarshithaKP authored and BethGriggs committed Apr 7, 2020
1 parent dc6c462 commit 6fca565
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/async_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -681,10 +681,10 @@ asyncResource.triggerAsyncId();
* `options` {Object}
* `triggerAsyncId` {number} The ID of the execution context that created this
async event. **Default:** `executionAsyncId()`.
* `requireManualDestroy` {boolean} Disables automatic `emitDestroy` when the
object is garbage collected. This usually does not need to be set (even if
`emitDestroy` is called manually), unless the resource's `asyncId` is
retrieved and the sensitive API's `emitDestroy` is called with it.
* `requireManualDestroy` {boolean} If set to `true`, disables `emitDestroy`
when the object is garbage collected. This usually does not need to be set
(even if `emitDestroy` is called manually), unless the resource's `asyncId`
is retrieved and the sensitive API's `emitDestroy` is called with it.
**Default:** `false`.

Example usage:
Expand Down

0 comments on commit 6fca565

Please sign in to comment.