diff options
| author | Gabriel Schulhof <gabriel.schulhof@intel.com> | 2020-06-30 01:10:31 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2020-07-03 23:57:50 +0300 |
| commit | cfa3d8fec5d9f6469c8d4ef077b53e0d9007dab9 (patch) | |
| tree | 6386e999b30826ddaafc08f3db949a737c2865e7 /doc/api/n-api.md | |
| parent | d853145277f3070053ed89cbaa91ad9218f3e1ac (diff) | |
doc: fix entry for `napi_create_external_buffer`
Remove text regarding copying, because `napi_create_external_buffer`
does not copy.
Fixes: https://github.com/nodejs/node/issues/33471
PR-URL: https://github.com/nodejs/node/pull/34125
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Mathias Buus <mathiasbuus@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/n-api.md')
| -rw-r--r-- | doc/api/n-api.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 9208dee5cd1..b34563bfaac 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -2054,7 +2054,7 @@ napi_status napi_create_external_buffer(napi_env env, * `[in] env`: The environment that the API is invoked under. * `[in] length`: Size in bytes of the input buffer (should be the same as the size of the new buffer). -* `[in] data`: Raw pointer to the underlying buffer to copy from. +* `[in] data`: Raw pointer to the underlying buffer to expose to JavaScript. * `[in] finalize_cb`: Optional callback to call when the `ArrayBuffer` is being collected. [`napi_finalize`][] provides more details. * `[in] finalize_hint`: Optional hint to pass to the finalize callback during |