doc: clarify operation of napi_cancel_async_work

Backport-PR-URL: #19447 PR-URL: #12974 Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jason Ginchereau <[email protected]>
nodejs · Apr 16, 2018 · 0f74ee5 · 0f74ee5
1 parent 263a633
commit 0f74ee5
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
@@ -2931,11 +2931,12 @@ NAPI_EXTERN napi_status napi_cancel_async_work(napi_env env,
 
 Returns `napi_ok` if the API succeeded.
 
-This API cancels a previously allocated work, provided
-it has not yet been queued for execution. After this function is called
+This API cancels queued work if it has not yet
+been started.  If it has already started executing, it cannot be
+cancelled and `napi_generic_failure` will be returned. If successful,
 the `complete` callback will be invoked with a status value of
 `napi_cancelled`. The work should not be deleted before the `complete`
-callback invocation, even when it was cancelled.
+callback invocation, even if it has been successfully cancelled.
 
 
 [Aynchronous Operations]: #n_api_asynchronous_operations