diff options
| author | Harshitha KP <harshi46@in.ibm.com> | 2020-03-27 09:22:45 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2020-04-07 18:28:20 +0300 |
| commit | 6fca5659d4440ca10e365523387c1f03845e4e95 (patch) | |
| tree | 78b157e596c17caa30b89e95ca11e01113dd2c76 /doc/api | |
| parent | dc6c462b38750cf2b4f546955646d066e5826aca (diff) | |
doc: clarify `requireManualDestroy` option
Fixes: https://github.com/nodejs/node/issues/32409
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/async_hooks.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 37354ce3864..17cdf61c39d 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -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: |