From 34074aa095d1c6a39fbaea7e2fb38c0321891913 Mon Sep 17 00:00:00 2001 From: Harshitha KP Date: Fri, 27 Mar 2020 02:22:45 -0400 Subject: [PATCH] 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 Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Vladimir de Turckheim --- doc/api/async_hooks.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 37354ce3864701..17cdf61c39da6c 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: