node_api_create_sharedarraybuffer
napi_status node_api_create_sharedarraybuffer(napi_env env,
size_t byte_length,
void** data,
napi_value* result) [in] env:调用该 API 时所处的环境。[in] byte_length:要创建的共享数组缓冲区的字节长度。[out] data:指向SharedArrayBuffer底层字节缓冲区的指针。可以通过传入NULL来选择性地忽略data。[out] result:一个napi_value,表示一个 JavaScriptSharedArrayBuffer。
如果 API 成功,则返回 napi_ok。
【Returns napi_ok if the API succeeded.】
此 API 返回与 JavaScript SharedArrayBuffer 对应的 Node-API 值。SharedArrayBuffer 用于表示可以在多个 worker 之间共享的固定长度二进制数据缓冲区。
【This API returns a Node-API value corresponding to a JavaScript SharedArrayBuffer.
SharedArrayBuffers are used to represent fixed-length binary data buffers that
can be shared across multiple workers.】
分配的 SharedArrayBuffer 将具有一个底层字节缓冲区,其大小由传入的 byte_length 参数决定。 底层缓冲区可以选择返回给调用者,以便调用者直接操作该缓冲区。 这个缓冲区只能由原生代码直接写入。要从 JavaScript 写入此缓冲区,需要创建一个类型化数组或 DataView 对象。
【The SharedArrayBuffer allocated will have an underlying byte buffer whose size is
determined by the byte_length parameter that's passed in.
The underlying buffer is optionally returned back to the caller in case the
caller wants to directly manipulate the buffer. This buffer can only be
written to directly from native code. To write to this buffer from JavaScript,
a typed array or DataView object would need to be created.】
JavaScript SharedArrayBuffer 对象在 ECMAScript 语言规范的 共享数组缓冲区对象部分 中有描述。
【JavaScript SharedArrayBuffer objects are described in
Section SharedArrayBuffer objects of the ECMAScript Language Specification.】