node_api_create_buffer_from_arraybuffer


napi_status NAPI_CDECL node_api_create_buffer_from_arraybuffer(napi_env env,
                                                              napi_value arraybuffer,
                                                              size_t byte_offset,
                                                              size_t byte_length,
                                                              napi_value* result) 
  • [in] env:API 调用时所处的环境。
  • [in] arraybuffer:将用于创建缓冲区的 ArrayBuffer
  • [in] byte_offset:在 ArrayBuffer 内开始创建缓冲区的字节偏移量。
  • [in] byte_length:要从 ArrayBuffer 创建的缓冲区的字节长度。
  • [out] result:表示创建的 JavaScript Buffer 对象的 napi_value

如果 API 成功,则返回 napi_ok

【Returns napi_ok if the API succeeded.】

此 API 从现有的 ArrayBuffer 创建一个 JavaScript Buffer 对象。Buffer 对象是 Node.js 特有的类,提供了一种在 JavaScript 中直接处理二进制数据的方法。

【This API creates a JavaScript Buffer object from an existing ArrayBuffer. The Buffer object is a Node.js-specific class that provides a way to work with binary data directly in JavaScript.】

字节范围 [byte_offset, byte_offset + byte_length) 必须在 ArrayBuffer 的边界内。如果 byte_offset + byte_length 超过 ArrayBuffer 的大小,将会抛出 RangeError 异常。

【The byte range [byte_offset, byte_offset + byte_length) must be within the bounds of the ArrayBuffer. If byte_offset + byte_length exceeds the size of the ArrayBuffer, a RangeError exception is raised.】