diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 5552aaf57bfcad..ca55d2f6e1d09c 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -4672,7 +4672,7 @@ napi_status napi_async_init(napi_env env, ``` * `[in] env`: The environment that the API is invoked under. -* `[in] async_resource`: An optional object associated with the async work +* `[in] async_resource`: Object associated with the async work that will be passed to possible `async_hooks` [`init` hooks][]. * `[in] async_resource_name`: Identifier for the kind of resource that is being provided for diagnostic information exposed by the @@ -4681,6 +4681,12 @@ napi_status napi_async_init(napi_env env, Returns `napi_ok` if the API succeeded. +In order to retain ABI compatibility with previous versions, +passing `NULL` for `async_resource` will not result in an error, however, +this will result incorrect operation of async hooks for the +napi_async_context created. Potential issues include include +loss of async context when using the AsyncLocalStorage API. + ### napi_async_destroy