1# Node-API 2 3## 简介 4 5Node-API是用于封装JavaScript能力为Native插件的API，独立于底层JavaScript，并作为Node.js的一部分。 6 7## 支持的能力 8 9Node-API可以去除底层的JavaScript引擎的差异，提供一套稳定的接口。 10 11OpenHarmony的Node-API组件对Node-API的接口进行了重新实现，底层对接了ArkJS等引擎。当前支持Node-API标准库中的部分接口。 12 13## 引入Node-API能力 14 15如果开发者需要使用Node-API相关功能，首先请添加头文件： 16 17```cpp 18#include <napi/native_api.h> 19``` 20 21其次在CMakeLists.txt中添加以下动态链接库： 22 23``` 24libace_napi.z.so 25``` 26 27## 已从Node-API组件标准库中导出的符号列表 28 29从Node-API标准库导出的接口，其使用方法及行为基于[Node.js](https://nodejs.org/docs/latest-v12.x/api/n-api.html)，并进行了部分[能力拓展](#node-api组件扩展的符号列表)。 30 31|符号类型|符号名|说明|起始支持API版本| 32| --- | --- | --- | --- | 33|FUNC|napi_module_register|napi native模块注册接口。|10| 34|FUNC|napi_get_last_error_info|获取`napi_extended_error_info`结构体，其中包含最近一次出现的error信息。|10| 35|FUNC|napi_throw|抛出一个js value。|10| 36|FUNC|napi_throw_error|抛出一个带文本信息的js `Error`。|10| 37|FUNC|napi_throw_type_error|抛出一个带文本信息的js `TypeError`。|10| 38|FUNC|napi_throw_range_error|抛出一个带文本信息的js `RangeError`。|10| 39|FUNC|napi_is_error|判断`napi_value`是否表示为一个error对象。|10| 40|FUNC|napi_create_error|创建并获取一个带文本信息的js `Error`。|10| 41|FUNC|napi_create_type_error|创建并获取一个带文本信息的js `TypeError`。|10| 42|FUNC|napi_create_range_error|创建并获取一个带文本信息的js `RangeError`。|10| 43|FUNC|napi_get_and_clear_last_exception|获取并清除最近一次出现的异常。|10| 44|FUNC|napi_is_exception_pending|判断是否出现了异常。|10| 45|FUNC|napi_fatal_error|引发致命错误以立即终止进程。|10| 46|FUNC|napi_open_handle_scope|创建一个上下文环境使用。|10| 47|FUNC|napi_close_handle_scope|关闭传入的上下文环境，关闭后，全部在其中声明的引用都将被关闭。|10| 48|FUNC|napi_open_escapable_handle_scope|创建出一个可逃逸的handle scope，可将范围内声明的值返回到父作用域。|10| 49|FUNC|napi_close_escapable_handle_scope|关闭传入的可逃逸的handle scope。|10| 50|FUNC|napi_escape_handle|提升传入的js object的生命周期到其父作用域。|10| 51|FUNC|napi_create_reference|为`Object`创建一个reference，以延长其生命周期。调用者需要自己管理reference生命周期。|10| 52|FUNC|napi_delete_reference|删除传入的reference。|10| 53|FUNC|napi_reference_ref|增加传入的reference的引用计数，并获取该计数。|10| 54|FUNC|napi_reference_unref|减少传入的reference的引用计数，并获取该计数。|10| 55|FUNC|napi_get_reference_value|获取与reference相关联的js `Object`。|10| 56|FUNC|napi_create_array|创建并获取一个js `Array`。|10| 57|FUNC|napi_create_array_with_length|创建并获取一个指定长度的js `Array`。|10| 58|FUNC|napi_create_arraybuffer|创建并获取一个指定大小的js `ArrayBuffer`。|10| 59|FUNC|napi_create_external|分配一个附加有外部数据的js value。|10| 60|FUNC|napi_create_external_arraybuffer|分配一个附加有外部数据的js `ArrayBuffer`。|10| 61|FUNC|napi_create_object|创建一个默认的js `Object`。|10| 62|FUNC|napi_create_symbol|创建一个js `Symbol`。|10| 63|FUNC|napi_create_typedarray|通过现有的`ArrayBuffer`创建一个js `TypeArray`。|10| 64|FUNC|napi_create_dataview|通过现有的`ArrayBuffer`创建一个js `DataView`。|10| 65|FUNC|napi_create_int32|通过一个C的`int32_t`数据创建js `Number`。|10| 66|FUNC|napi_create_uint32|通过一个C的`uint32_t`数据创建js `Number`。|10| 67|FUNC|napi_create_int64|通过一个C的`int64_t`数据创建js `Number`。|10| 68|FUNC|napi_create_double|通过一个C的`double`数据创建js `Number`。|10| 69|FUNC|napi_create_string_latin1|通过ISO-8859-1编码的C字符串数据创建js `String`。|10| 70|FUNC|napi_create_string_utf8|通过UTF8编码的C字符串数据创建js `String`。|10| 71|FUNC|napi_create_string_utf16|通过UTF16编码的C字符串数据创建js `String`。|10| 72|FUNC|napi_get_array_length|获取array的length。|10| 73|FUNC|napi_get_arraybuffer_info|获取`ArrayBuffer`的底层data buffer及其长度。|10| 74|FUNC|napi_get_prototype|获取给定js `Object`的`prototype`。|10| 75|FUNC|napi_get_typedarray_info|获取给定`TypedArray`的各种属性。|10| 76|FUNC|napi_get_dataview_info|获取给定`DataView`的各种属性。|10| 77|FUNC|napi_get_value_bool|获取给定js `Boolean`对应的C bool值。|10| 78|FUNC|napi_get_value_double|获取给定js `Number`对应的C double值。|10| 79|FUNC|napi_get_value_external|获取先前通过napi_create_external()传递的外部数据指针。|10| 80|FUNC|napi_get_value_int32|获取给定js `Number`对应的C int32值。|10| 81|FUNC|napi_get_value_int64|获取给定js `Number`对应的C int64值。|10| 82|FUNC|napi_get_value_string_latin1|获取给定js value对应的ISO-8859-1编码的字符串。|10| 83|FUNC|napi_get_value_string_utf8|获取给定js value对应的UTF8编码的字符串。|10| 84|FUNC|napi_get_value_string_utf16|获取给定js value对应的UTF16编码的字符串。|10| 85|FUNC|napi_get_value_uint32|获取给定js `Number`对应的C uint32值。|10| 86|FUNC|napi_get_boolean|根据给定的C boolean值，获取js bool对象。|10| 87|FUNC|napi_get_global|获取`global`对象。|10| 88|FUNC|napi_get_null|获取`null`对象。|10| 89|FUNC|napi_get_undefined|获取`undefined`对象。|10| 90|FUNC|napi_coerce_to_bool|将给定的js value强转成js `Boolean`。|10| 91|FUNC|napi_coerce_to_number|将给定的js value强转成js `Number`。|10| 92|FUNC|napi_coerce_to_object|将给定的js value强转成js `Object`。|10| 93|FUNC|napi_coerce_to_string|将给定的js value强转成js `String`。|10| 94|FUNC|napi_typeof|获取给定js value的js type。|10| 95|FUNC|napi_instanceof|判断给定object是否为给定constructor的实例。|10| 96|FUNC|napi_is_array|判断给定js value是否为array。|10| 97|FUNC|napi_is_arraybuffer|判断给定js value是否为`ArrayBuffer`。|10| 98|FUNC|napi_is_typedarray|判断给定js value是否表示一个`TypedArray`。|10| 99|FUNC|napi_is_dataview|判断给定js value是否表示一个`DataView`。|10| 100|FUNC|napi_is_date|判断给定js value是否为js `Date`对象。|10| 101|FUNC|napi_strict_equals|判断给定的两个js value是否严格相等。|10| 102|FUNC|napi_get_property_names|以字符串数组的形式获取对象的可枚举属性的名称。|10| 103|FUNC|napi_set_property|对给定`Object`设置属性。|10| 104|FUNC|napi_get_property|获取给定`Object`的给定属性。|10| 105|FUNC|napi_has_property|判断给定对象中是否存在给定属性。|10| 106|FUNC|napi_delete_property|尝试从给定`Object`中删除给定`key`属性。|10| 107|FUNC|napi_has_own_property|判断给定`Object`中是否有名为`key`的own property。|10| 108|FUNC|napi_set_named_property|对给定`Object`设置一个给定名称的属性。|10| 109|FUNC|napi_get_named_property|获取给定`Object`中指定名称的属性。|10| 110|FUNC|napi_has_named_property|判断给定`Object`中是否有给定名称的属性。|10| 111|FUNC|napi_set_element|在给定`Object`的指定索引处，设置元素。|10| 112|FUNC|napi_get_element|获取给定`Object`指定索引处的元素。|10| 113|FUNC|napi_has_element|若给定`Object`的指定索引处拥有属性，获取该元素。|10| 114|FUNC|napi_delete_element|尝试删除给定`Object`的指定索引处的元素。|10| 115|FUNC|napi_define_properties|批量的向给定`Object`中定义属性。|10| 116|FUNC|napi_type_tag_object|将tag指针的值与`Object`关联。|10| 117|FUNC|napi_check_object_type_tag|判断给定的tag指针是否被关联到了js `Object`上。|10| 118|FUNC|napi_call_function|在Native方法中调用js function，即native call js。|10| 119|FUNC|napi_create_function|创建native方法给js使用，以便于js call native。|10| 120|FUNC|napi_get_cb_info|从给定的callback info中获取有关调用的详细信息，如参数和this指针。|10| 121|FUNC|napi_get_new_target|获取构造函数调用的`new.target`。|10| 122|FUNC|napi_new_instance|通过给定的构造函数，构建一个实例。|10| 123|FUNC|napi_define_class|定义与C++类相对应的JavaScript类。|10| 124|FUNC|napi_wrap|在js object上绑定一个native对象实例。|10| 125|FUNC|napi_unwrap|从js object上获取先前绑定的native对象实例。|10| 126|FUNC|napi_remove_wrap|从js object上获取先前绑定的native对象实例，并解除绑定。|10| 127|FUNC|napi_create_async_work|创建一个异步工作对象。|10| 128|FUNC|napi_delete_async_work|释放先前创建的异步工作对象。|10| 129|FUNC|napi_queue_async_work|将异步工作对象加到队列，由底层去调度执行。|10| 130|FUNC|napi_cancel_async_work|取消入队的异步任务。|10| 131|FUNC|napi_async_init|创建一个异步资源上下文环境（不支持与async_hook相关能力）。|11| 132|FUNC|napi_make_callback|在异步资源上下文环境中回调JS函数(不支持与async_hook相关能力)。|11| 133|FUNC|napi_async_destroy|销毁先前创建的异步资源上下文环境（不支持与async_hook相关能力）。|11| 134|FUNC|napi_open_callback_scope|创建一个回调作用域（不支持与async_hook相关能力）。|11| 135|FUNC|napi_close_callback_scope|关闭先前创建的回调作用域（不支持与async_hook相关能力）。|11| 136|FUNC|napi_get_node_version|获取node的版本信息。|10| 137|FUNC|napi_get_version|获取Node运行时支持的最高 N-API 版本。|10| 138|FUNC|napi_create_promise|创建一个延迟对象和js promise。|10| 139|FUNC|napi_resolve_deferred|resolve与js promise对象关联的延迟函数。|10| 140|FUNC|napi_reject_deferred|reject与js promise对象关联的延迟函数。|10| 141|FUNC|napi_is_promise|判断给定js value是否为promise对象。|10| 142|FUNC|napi_get_uv_event_loop|获取当前libuv loop实例。|10| 143|FUNC|napi_create_threadsafe_function|创建线程安全函数。|10| 144|FUNC|napi_get_threadsafe_function_context|获取线程安全函数中的context。|10| 145|FUNC|napi_call_threadsafe_function|调用线程安全函数。|10| 146|FUNC|napi_acquire_threadsafe_function|指示线程安全函数可以开始使用。|10| 147|FUNC|napi_release_threadsafe_function|指示线程安全函数将停止使用。|10| 148|FUNC|napi_ref_threadsafe_function|指示在主线程上运行的事件循环在线程安全函数被销毁之前不应退出。|10| 149|FUNC|napi_unref_threadsafe_function|指示在主线程上运行的事件循环可能会在线程安全函数被销毁之前退出。|10| 150|FUNC|napi_create_date|通过一个C的`double`数据创建js `Date`。|10| 151|FUNC|napi_get_date_value|获取给定js `Date`对应的C double值。|10| 152|FUNC|napi_create_bigint_int64|通过一个C的`int64`数据创建js `BigInt`。|10| 153|FUNC|napi_create_bigint_uint64|通过一个C的`uint64`数据创建js `BigInt`。|10| 154|FUNC|napi_create_bigint_words|通过一个C的`uint64`数组创建单个js `BigInt`。|10| 155|FUNC|napi_get_value_bigint_int64|获取给定js `BigInt`对应的C int64值。|10| 156|FUNC|napi_get_value_bigint_uint64|获取给定js `BigInt`对应的C uint64值。|10| 157|FUNC|napi_get_value_bigint_words|获取给定js `BigInt`对应的信息，包括符号位、64位小端序数组和数组中的元素个数。|10| 158|FUNC|napi_create_buffer|创建并获取一个指定大小的js `Buffer`。|10| 159|FUNC|napi_create_buffer_copy|创建并获取一个指定大小的js `Buffer`，并以给定数据进行初始化。|10| 160|FUNC|napi_create_external_buffer|创建并获取一个指定大小的js `Buffer`，并以给定数据进行初始化，该接口可为`Buffer`附带额外数据。|10| 161|FUNC|napi_get_buffer_info|获取js `Buffer`底层data及其长度。|10| 162|FUNC|napi_is_buffer|判断给定js value是否为`Buffer`对象。|10| 163|FUNC|napi_object_freeze|冻结给定的对象。|10| 164|FUNC|napi_object_seal|密封给定的对象。|10| 165|FUNC|napi_get_all_property_names|获取一个数组，其中包含此对象过滤后的属性名称。|10| 166|FUNC|napi_detach_arraybuffer|分离给定`ArrayBuffer`的底层数据。|10| 167|FUNC|napi_is_detached_arraybuffer|判断给定的`ArrayBuffer`是否已被分离过。|10| 168|FUNC|napi_run_script|将给定对象作为js代码运行。当前接口实际为空实现，可使用系统拓展接口`napi_run_script_path`接口，提升安全性。|10| 169|FUNC|napi_set_instance_data|绑定与当前运行的环境相关联的数据项。|11| 170|FUNC|napi_get_instance_data|检索与当前运行的环境相关联的数据项。|11| 171|FUNC|napi_add_env_cleanup_hook|注册环境清理钩子函数。|11| 172|FUNC|napi_remove_env_cleanup_hook|取消环境清理钩子函数。|11| 173|FUNC|napi_add_async_cleanup_hook|注册清理异步钩子函数。|11| 174|FUNC|napi_remove_async_cleanup_hook|取消清理异步钩子函数。|11| 175|FUNC|node_api_get_module_file_name|用于获取加载项加载位置的绝对路径。|11| 176|FUNC|napi_add_finalizer|当js `Object`中的对象被垃圾回收时调用注册的napi_finalize回调。|11| 177|FUNC|napi_fatal_exception|向js抛出 `UncaughtException`。|12| 178 179## 已导出符号列表与标准库对应符号的差异 180 181### napi_throw_error 182 183**返回：** 184 185- 当code为空指针时，标准库会返回napi_invalid_arg，而OpenHarmony中未做判断。 186 187- 该导出接口允许code属性设置失败。 188 189### napi_throw_type_error 190 191**返回：** 192 193- 当code为空指针时，标准库会返回napi_invalid_arg，而OpenHarmony中未做判断。 194 195- 该导出接口允许code属性设置失败。 196 197### napi_throw_range_error 198 199**返回：** 200 201- 当code为空指针时，标准库会返回napi_invalid_arg，而OpenHarmony中未做判断。 202 203- 该导出接口允许code属性设置失败。 204 205### napi_create_error 206 207**参数：** 208 209- code: 该导出接口支持String或Number类型。 210 211**返回：** 212 213- 当code类型不匹配时，该导出接口返回napi_invalid_arg。 214 215- 该导出接口允许code属性设置失败。 216 217### napi_create_type_error 218 219**参数：** 220 221- code: 该导出接口支持String或Number类型。 222 223**返回：** 224 225- 当code类型不匹配时，该导出接口返回napi_invalid_arg。 226 227- 该导出接口允许code属性设置失败。 228 229- OpenHarmony中创建的错误类型为Error。 230 231### napi_create_range_error 232 233**参数：** 234 235- code: OpenHarmony中支持String或Number类型。 236 237**返回：** 238 239- 当code类型不匹配时，该导出接口返回napi_invalid_arg。 240 241- 该导出接口允许code属性设置失败。 242 243- OpenHarmony中创建的错误类型为Error。 244 245### napi_create_reference 246 247**参数：** 248 249- value: 标准库中仅支持Object、Function、Symbol类型，而该导出接口对value的类型没有限制。 250 251### napi_delete_reference 252 253**说明：** 254 255- 在OpenHarmony中，如果创建强引用时注册了napi_finalize回调函数，调用该接口的时候会触发该napi_finalize回调。 256 257### napi_create_symbol 258 259**返回：** 260 261- 当入参description不为空且不是String对象时，该导出接口返回napi_invalid_arg。 262 263### napi_create_typedarray 264 265**返回：** 266 267- 当入参arraybuffer不为空且不为ArrayBuffer对象时，该导出接口返回napi_arraybuffer_expected。 268 269### napi_create_dataview 270 271**返回：** 272 273- 当入参arraybuffer不为空且不为ArrayBuffer对象时，该导出接口返回napi_arraybuffer_expected。 274 275- 如果byte_offset与byte_length的和大于arraybuffer的大小，该导出接口将会抛出RangeError异常，并返回napi_pending_exception。 276 277### napi_get_typedarray_info 278 279**参数：** 280 281- object: 该导出接口支持TypedArray或[Sendable TypedArray](../apis-arkts/js-apis-arkts-collections.md#collectionstypedarray)类型。 282 283**返回：** 284 285- 标准库接口中出参length返回typedarray的元素数量，而OpenHarmony的该导出接口返回typedarray中元素的字节长度。 286 287### napi_coerce_to_object 288 289**返回：** 290 291- 当value为undefined或null时，该导出接口返回napi_ok，出参result为undefined。 292 293### napi_instanceof 294 295**返回：** 296 297- 当参数object不是Object对象时，该导出接口直接返回napi_object_expected，result不做处理。 298 299- 当参数constructor不是Function对象时，该导出接口不会抛出异常，接口返回napi_function_expected。 300 301### napi_is_typedarray 302 303**参数：** 304 305- value: 该导出接口额外支持[Sendable TypedArray](../apis-arkts/js-apis-arkts-collections.md#collectionstypedarray)类型。 306 307### napi_get_property_names 308 309**返回：** 310 311- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 312 313### napi_set_property 314 315**返回：** 316 317- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 318 319### napi_get_property 320 321**返回：** 322 323- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 324 325### napi_has_property 326 327**返回：** 328 329- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 330 331### napi_delete_property 332 333**返回：** 334 335- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 336 337### napi_has_own_property 338 339**返回：** 340 341- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 342 343### napi_set_named_property 344 345**返回：** 346 347- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 348 349### napi_get_named_property 350 351**返回：** 352 353- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 354 355### napi_has_named_property 356 357**返回：** 358 359- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 360 361### napi_set_element 362 363**返回：** 364 365- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 366 367- 当设置的index超大的时候，标准库中会直接抛出异常并中断进程，OpenHarmony中会尝试分配内存，若分配失败则不对object进行修改。 368 369### napi_get_element 370 371**返回：** 372 373- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 374 375### napi_has_element 376 377**返回：** 378 379- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 380 381### napi_delete_element 382 383**返回：** 384 385- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 386 387### napi_define_properties 388 389**返回：** 390 391- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 392 393- 若在遍历设置属性的过程中触发异常，标准库中会直接将异常抛出，OpenHarmony中会清除异常继续执行。 394 395### napi_type_tag_object 396 397**返回：** 398 399- 当参数js_object不是Object或Function对象时，该导出接口返回napi_object_expected。 400 401### napi_check_object_type_tag 402 403**返回：** 404 405- 当参数js_object不是Object或Function对象时，该导出接口返回napi_object_expected。 406 407### napi_call_function 408 409**返回：** 410 411- 该导出接口不会去校验参数recv是否为nullptr。 412 413- 当参数func不是Function对象时，该导出接口返回napi_function_expected。 414 415### napi_new_instance 416 417**返回：** 418 419- 当参数constructor不是Function对象时，该导出接口返回napi_function_expected。 420 421### napi_define_class 422 423**返回：** 424 425- 当length不为NAPI_AUTO_LENGTH且大于INT_MAX时，该导出接口返回napi_object_expected。 426 427### napi_wrap 428 429**参数：** 430 431- finalize_cb: 标准库允许为空， OpenHarmony在该参数为空时，返回napi_invalid_arg。 432- result: 标准库返回弱引用， OpenHarmony在result不为空时返回强引用。 433 434**返回：** 435 436- 参数js_object不为Object或Function对象时，该导出接口返回napi_object_expected。 437 438### napi_unwrap 439 440**返回：** 441 442- 参数js_object不为Object或Function对象时，该导出接口返回napi_object_expected。 443 444### napi_remove_wrap 445 446**返回：** 447 448- 参数js_object不为Object或Function对象时，该导出接口返回napi_object_expected。 449 450**说明：** 451 452- 如果封装中关联有finalize回调，OpenHarmony中该导出接口将在移除封装前调用它。 453 454### napi_create_async_work 455 456**参数：** 457 458- 该导出接口暂时不支持async_hooks资源管理机制。 459 460- 该导出接口不会校验入参async_resource_name是否为String类型对象。 461 462- 由于当前暂不支持async_hooks资源管理机制，入参async_resource暂时也不做处理。 463 464### napi_delete_async_work 465 466**参数：** 467 468- 该导出接口暂时不支持async_hooks资源管理机制。 469 470### napi_queue_async_work 471 472**参数：** 473 474- 该导出接口暂时不支持async_hooks资源管理机制。 475 476### napi_cancel_async_work 477 478**返回：** 479 480- 若因为底层uv导致取消任务失败，标准库会根据失败原因，返回napi_generic_failure或napi_invalid_arg或napi_cancelled，而在OpenHarmony上该导出接口不会去校验uv的返回值，开发者可以根据相关的日志去排查任务是否取消失败。 481 482### napi_async_init 483 484**说明：** 485 486- OpenHarmony暂不支持async_hooks资源管理机制。目前未实现与async_hooks交互的内容，该接口调用后并不会有async_hooks的相关操作。 487 488### napi_make_callback 489 490**说明：** 491 492- OpenHarmony暂不支持async_hooks资源管理机制。目前未实现与async_hooks交互的内容，该接口调用后并不会有async_hooks的相关操作。 493 494### napi_async_destroy 495 496**说明：** 497 498- OpenHarmony暂不支持async_hooks资源管理机制。目前未实现与async_hooks交互的内容，接口调用后并不会有async_hooks的相关操作。 499 500### napi_get_node_version 501 502**说明：** 503 504- OpenHarmony不需要获取node的版本，故当前该导出接口为空实现。 505 506### napi_resolve_deferred 507 508**说明：** 509 510- promise的then方法的resolve或者reject回调中出现异常时，如果promise没有catch块，代码会继续执行不会崩溃；如果promise有catch块，则异常会被该catch块捕获。 511 512### napi_reject_deferred 513 514**说明：** 515 516- promise的then方法的resolve或者reject回调中出现异常时，如果promise没有catch块，代码会继续执行不会崩溃；如果promise有catch块，则异常会被该catch块捕获。 517 518### napi_create_threadsafe_function 519 520**参数：** 521 522- initial_thread_count: OpenHarmony中上限为128。 523 524- async_resource: OpenHarmony中不做类型限制。 525 526- async_resource_name: OpenHarmony中不做类型限制。 527 528- func: OpenHarmony中不做类型限制。 529 530**说明：** 531 532- OpenHarmony中，创建线程安全函数的过程中没有注册cleanup hook方法，如有需要可以调用napi_add_env_cleanup_hook。 533 534### napi_call_threadsafe_function 535 536**说明：** 537 538- OpenHarmony调用uv_async_send接口前会检查env是否存活。 539 540- 调用uv_async_send接口失败时，OpenHarmony中会返回napi_generic_failure。 541 542### napi_release_threadsafe_function 543 544**说明：** 545 546- OpenHarmony调用uv_async_send接口前会检查env是否存活。 547 548- ThreadCount为0时，OpenHarmony中会返回napi_generic_failure。 549 550### napi_ref_threadsafe_function 551 552**说明：** 553 554- OpenHarmony中有校验func和env是否为同一ArkTS线程的过程，若不是同一线程则会返回napi_generic_failure。 555 556### napi_unref_threadsafe_function 557 558**说明：** 559 560- OpenHarmony中有校验func和env是否为同一ArkTS线程的过程，若不是同一线程则会返回napi_generic_failure。 561 562### napi_create_date 563 564**返回：** 565 566- 当入参正常但date创建失败时，标准库中返回napi_generic_failure，而OpenHarmony中将会抛出异常，并且接口返回napi_pending_exception。 567 568### napi_create_bigint_words 569 570**返回：** 571 572- 当入参正常但bigInt创建失败时，标准库中返回napi_generic_failure，而OpenHarmony中将会抛出异常，并且接口返回napi_pending_exception。 573 574### napi_get_value_bigint_words 575 576**返回：** 577 578- 当参数value不是BigInt对象时，OpenHarmony中返回napi_object_expected。 579 580### napi_create_buffer 581 582**返回：** 583 584- OpenHarmony中创建的buffer类型为ArrayBufferLike。 585 586- OpenHarmony中，size小于等于0时返回napi_invalid_arg。 587 588- OpenHarmony中，size大于2097152时返回napi_invalid_arg并打印错误日志。 589 590- OpenHarmony中，data为nullptr时返回napi_invalid_arg。 591 592- 标准库中，进入或退出接口前若有异常将直接返回napi_pending_exception，OpenHarmony中没有对此做校验。 593 594### napi_create_buffer_copy 595 596**返回：** 597 598- OpenHarmony中创建的buffer类型为ArrayBufferLike。 599 600- OpenHarmony中，length小于等于0时返回napi_invalid_arg。 601 602- OpenHarmony中，length大于2097152时返回napi_invalid_arg并打印错误日志。 603 604- OpenHarmony中，data为nullptr时返回napi_invalid_arg。 605 606- 标准库中，进入或退出接口前若有异常将直接返回napi_pending_exception，OpenHarmony中没有对此做校验。 607 608### napi_create_external_buffer 609 610**返回：** 611 612- OpenHarmony中创建的buffer类型为ArrayBufferLike。 613 614- OpenHarmony中，length小于等于0时返回napi_invalid_arg。 615 616- OpenHarmony中，length大于2097152时返回napi_invalid_arg并打印错误日志。 617 618- 标准库中，因未知原因导致创建失败时将返回napi_generic_failure，OpenHarmony中返回napi_pending_exception。 619 620### napi_get_buffer_info 621 622**返回：** 623 624- OpenHarmony会对value是否属于buffer进行判断，若不属于则返回napi_arraybuffer_expected。 625 626### napi_detach_arraybuffer 627 628**返回：** 629 630- 当入参arraybuffer不为Object对象时，该导出接口返回napi_object_expected；当arraybuffer是Object对象但不为ArrayBuffer对象时，该导出接口返回napi_invalid_arg。 631 632### napi_add_env_cleanup_hook 633 634**说明：** 635 636- data已注册到env中时，OpenHarmony仅打印异常日志。 637 638### napi_add_finalizer 639 640**返回：** 641 642- 入参js_object不是Object对象时，OpenHarmony中该导出接口返回napi_object_expected。 643 644**说明：** 645 646- OpenHarmony中，当强引用delete时直接进行回调，无需等到对象析构。 647 648- 回调主动抛出异常时，OpenHarmony会触发JSCrash。 649 650**说明：** 651 652- 标准库中返回弱引用， OpenHarmony在result不为空时返回强引用。 653 654### napi_fatal_exception 655 656**参数：** 657 658- err: OpenHarmony中仅支持Error类型，类型不匹配将返回napi_invalid_arg。 659 660### napi_get_uv_event_loop 661 662**返回：** 663 664- 参数env不是有效的napi_env（例如此env已被释放）时，该导出接口返回napi_generic_failure。 665 666### napi_create_array_with_length 667 668**返回：** 669 670- 当length数值过大时，标准库中会直接抛出异常并中断进程，OpenHarmony中会尝试分配内存，若分配失败则抛出异常并返回长度为0的array。 671 672### napi_create_arraybuffer 673 674**返回：** 675 676- 当length数值过大时，标准库中会直接抛出异常并中断进程，OpenHarmony中会尝试分配内存，若分配失败则抛出异常并返回undefined。 677 678## 未从Node-API组件标准库中导出的符号列表 679 680|符号类型|符号名|说明| 681| --- | --- | --- | 682|FUNC|napi_adjust_external_memory|调整js `Object`持有的外部内存。| 683 684## Node-API组件扩展的符号列表 685 686|符号类型|符号名|说明|起始支持API版本| 687| --- | --- | --- | --- | 688|FUNC|napi_queue_async_work_with_qos|将异步工作对象加到队列，由底层根据传入的qos优先级去调度执行。|10| 689|FUNC|napi_run_script_path|运行abc文件。|10| 690|FUNC|napi_load_module|将abc文件作为模块加载，返回模块的命名空间。|11| 691|FUNC|napi_create_object_with_properties|使用给定的napi_property_descriptor创建js `Object`。descriptor的键名必须为 string，且不可转为number。|11| 692|FUNC|napi_create_object_with_named_properties|使用给定的napi_value和键名创建js `Object`。键名必须为 string，且不可转为number。|11| 693|FUNC|napi_coerce_to_native_binding_object|强制将js `Object`和Native对象绑定。|11| 694|FUNC|napi_create_ark_runtime|创建基础运行时环境。|12| 695|FUNC|napi_destroy_ark_runtime|销毁基础运行时环境。|12| 696|FUNC|napi_run_event_loop|触发底层的事件循环。|12| 697|FUNC|napi_stop_event_loop|停止底层的事件循环。|12| 698|FUNC|napi_load_module_with_info|将abc文件作为模块加载，返回模块的命名空间。可在新创建的ArkTS基础运行时环境中使用。|12| 699|FUNC|napi_serialize|将ArkTS对象转换为native数据。|12| 700|FUNC|napi_deserialize|将native数据转为ArkTS对象。|12| 701|FUNC|napi_delete_serialization_data|删除序列化数据。|12| 702|FUNC|napi_call_threadsafe_function_with_priority|将指定优先级和入队方式的任务投递到ArkTS主线程。|12| 703|FUNC|napi_is_sendable|判断给定JS value是否是Sendable的。|12| 704|FUNC|napi_define_sendable_class|创建一个Sendable类。|12| 705|FUNC|napi_create_sendable_object_with_properties | 使用给定的napi_property_descriptor创建一个Sendable对象。|12| 706|FUNC|napi_create_sendable_array | 创建一个Sendable数组。|12| 707|FUNC|napi_create_sendable_array_with_length | 创建一个指定长度的Sendable数组。|12| 708|FUNC|napi_create_sendable_arraybuffer | 创建一个Sendable ArrayBuffer。|12| 709|FUNC|napi_create_sendable_typedarray | 创建一个Sendable TypedArray。|12| 710|FUNC|napi_wrap_sendable | 包裹一个native实例到ArkTS对象中。|12| 711|FUNC|napi_wrap_sendable_with_size | 包裹一个native实例到ArkTS对象中并指定大小。|12| 712|FUNC|napi_unwrap_sendable | 获取ArkTS对象包裹的native实例。|12| 713|FUNC|napi_remove_wrap_sendable | 移除并获取ArkTS对象包裹的native实例。|12| 714 715> 说明： 716> 717> 有关Sendable特性的介绍，详见[Sendable开发指导](../../arkts-utils/arkts-sendable.md)。 718 719### napi_qos_t 720 721```cpp 722typedef enum { 723 napi_qos_background = 0, // 低等级，用户不可见任务，例如数据同步、备份。 724 napi_qos_utility = 1, // 中低等级，不需要立即看到响应效果的任务，例如下载或导入数据。 725 napi_qos_default = 2, // 默认 726 napi_qos_user_initiated = 3, // 高等级，用户触发并且可见进展，例如打开文档。 727} napi_qos_t; 728``` 729 730**描述：** 731表示QoS的枚举值，QoS决定了线程调度的优先级 732 733### napi_event_mode 734 735```cpp 736typedef enum { 737 napi_event_mode_default = 0, // 阻塞式的运行底层事件循环，直到循环中没有任何任务时退出事件循环。 738 napi_event_mode_nowait = 1, // 非阻塞式的运行底层事件循环，尝试去处理一个任务，处理完之后退出事件循环；如果事件循环中没有任务，立刻退出事件循环。 739} napi_event_mode; 740``` 741 742**描述：** 743用于运行事件循环的事件模式。 744 745### napi_queue_async_work_with_qos 746 747```cpp 748napi_status napi_queue_async_work_with_qos(napi_env env, 749 napi_async_work work, 750 napi_qos_t qos); 751``` 752 753**描述：** 754 755将异步工作对象加到队列，由底层根据传入的qos优先级去调度执行。 756 757**参数：** 758 759- [in] env: Node-API的环境对象，表示当前的执行环境。 760 761- [in] work: 一个表示异步工作项的对象。这个对象通常是通过napi_create_async_work函数创建的。 762 763- [in] qos: 决定了线程调度的优先级。 764 765**返回：** 766 767如果API成功，则返回napi_ok。 768 769### napi_run_script_path 770 771```cpp 772napi_status napi_run_script_path(napi_env env, 773 const char* abcPath, 774 napi_value* result); 775``` 776 777**描述：** 778 779运行指定abc文件。 780 781**参数：** 782 783- [in] env: Node-API的环境对象，表示当前的执行环境。 784 785- [in] abcPath: 要运行的脚本的JavaScript路径。这是一个字符串，指定了要运行的脚本文件的位置。 786 787- [out] result: 一个指向napi_value类型的指针，用于存储运行脚本的结果。 788 789**返回：** 790 791如果API成功，则返回napi_ok。 792 793### napi_load_module 794 795```cpp 796napi_status napi_load_module(napi_env env, 797 const char* path, 798 napi_value* result); 799``` 800 801**描述：** 802 803加载系统模块或开发者自定义的模块，返回模块的命名空间。 804 805**参数：** 806 807- [in] env: Node-API的环境对象，表示当前的执行环境。 808 809- [in] path: 要加载的系统模块的名称或开发者自定义模块的路径。 810 811- [out] result: 一个指向napi_value类型的指针，用于存储加载模块的结果。 812 813**返回：** 814 815如果API成功，则返回napi_ok。 816 817### napi_create_object_with_properties 818 819```cpp 820napi_status napi_create_object_with_properties(napi_env env, 821 napi_value* result, 822 size_t property_count, 823 const napi_property_descriptor* properties); 824``` 825 826**描述：** 827 828属性描述符napi_property_descriptor用于描述一个属性，它包括属性的名称获取和设置方法、属性特性等信息。通过传入这些描述符，可以在创建对象时就定义属性。 829 830使用给定的napi_property_descriptor创建js Object。descriptor的键名必须为string，且不可转为number。 831 832**参数：** 833 834- [in] env: Node-API的环境对象，表示当前的执行环境。 835 836- [out] result: 一个指向napi_value类型的指针，用于存储创建的对象。 837 838- [in] property_count: 要添加到对象中的属性的数量。 839 840- [in] properties: 一个指向napi_property_descriptor数组的指针，描述了要添加到对象中的属性的信息。 841 842**返回：** 843 844如果API成功，则返回napi_ok。 845 846### napi_create_object_with_named_properties 847 848```cpp 849napi_status napi_create_object_with_named_properties(napi_env env, 850 napi_value* result, 851 size_t property_count, 852 const char** keys, 853 const napi_value* values); 854``` 855 856**描述：** 857 858使用给定的napi_value和键名创建js Object。键名必须为string，且不可转为number。 859 860**参数：** 861 862- [in] env: Node-API的环境对象，表示当前的执行环境。 863 864- [out] result: 一个指向napi_value类型的指针，用于存储创建的对象。 865 866- [in] property_count: 要添加到对象中的属性的数量。 867 868- [in] keys: 一个指向const char*数组的指针，表示属性的名称。 869 870- [in] values: 一个指向napi_value数组的指针，表示属性的值，与属性名称一一对应。 871 872**返回：** 873 874如果API成功，则返回napi_ok。 875 876### napi_coerce_to_native_binding_object 877 878```cpp 879napi_status napi_coerce_to_native_binding_object(napi_env env, 880 napi_value js_object, 881 napi_native_binding_detach_callback detach_cb, 882 napi_native_binding_attach_callback attach_cb, 883 void* native_object, 884 void* hint); 885``` 886 887**描述：** 888 889用于给JS Object绑定回调和回调所需的参数，转成携带Native信息的JS Object。 890 891**参数：** 892 893- [in] env: Node-API的环境对象，表示当前的执行环境。 894 895- [in] js_object: 要转换的JavaScript对象。 896 897- [in] detach_cb: 解绑回调，一般在序列化时调用，可在对象解绑时执行一些清理操作。 898 899- [in] attach_cb: 绑定回调，一般在序列化时调用。 900 901- [in] native_object: 需要传递给回调的参数，不能为空。 902 903- [in] hint: 一个指针，可以用于传递附加的信息给回调函数。 904 905**返回：** 906 907如果API成功，则返回napi_ok。 908 909### napi_create_ark_runtime 910 911```cpp 912napi_status napi_create_ark_runtime(napi_env *env) 913``` 914 915**描述：** 916 917创建基础运行时环境。 918 919**参数：** 920 921- [in] env: Node-API的环境对象，表示当前的执行环境。 922 923**返回：** 924 925如果API成功，则返回napi_ok。 926 927### napi_destroy_ark_runtime 928 929```cpp 930napi_status napi_destroy_ark_runtime(napi_env *env) 931``` 932 933**描述：** 934 935销毁基础运行时环境。 936 937**参数：** 938 939- [in] env: Node-API的环境对象，表示当前的执行环境。 940 941**返回：** 942 943如果API成功，则返回napi_ok。 944 945### napi_run_event_loop 946 947```cpp 948napi_status napi_run_event_loop(napi_env env, napi_event_mode mode) 949``` 950 951**描述：** 952 953触发底层的事件循环。 954 955**参数：** 956 957- [in] env: Node-API的环境对象，表示当前的执行环境。 958- [in] mode: 用于运行事件循环的事件模式。 959 960**返回：** 961 962如果API成功，则返回napi_ok。 963 964### napi_stop_event_loop 965 966```cpp 967napi_status napi_stop_event_loop(napi_env env) 968``` 969 970**描述：** 971 972停止底层的事件循环。 973 974**参数：** 975 976- [in] env: Node-API的环境对象，表示当前的执行环境。 977 978**返回：** 979 980如果API成功，则返回napi_ok。 981 982### napi_load_module_with_info 983 984```cpp 985napi_status napi_load_module_with_info(napi_env env, 986 const char* path, 987 const char* module_info, 988 napi_value* result) 989``` 990 991**描述：** 992 993将abc文件作为模块加载，返回模块的命名空间。可在新创建的ArkTS基础运行时环境中使用。 994 995**参数：** 996 997- [in] env: Node-API的环境对象，表示当前的执行环境。 998 999- [in] path: 要加载的模块的路径。 1000 1001- [in] module_info: 模块信息。这是一个包含模块信息字符串。模块信息可以用于指定模块的版本、作者、描述等详细信息。 1002 1003- [out] result: 指向napi_value的指针，用于接收模块的结果。 1004 1005**返回：** 1006 1007如果API成功，则返回napi_ok。 1008 1009### napi_serialize 1010 1011```cpp 1012napi_status napi_serialize(napi_env env, 1013 napi_value object, 1014 napi_value transfer_list, 1015 napi_value clone_list, 1016 void** result) 1017``` 1018 1019**描述：** 1020 1021将ArkTS对象转换为native数据。 1022 1023**参数：** 1024 1025- [in] env: Node-API的环境对象，表示当前的执行环境。 1026 1027- [in] object: 要序列化的JavaScript对象。 1028 1029- [in] transfer_list: 传输列表，包含需要在序列化过程中转移的JavaScript对象。 1030 1031- [in] clone_list: 克隆列表，包含需要在序列化过程中克隆的JavaScript对象。 1032 1033- [out] result: 用于接收序列化结果的指针。在调用完成后，指向实际结果的指针会存储在此位置。 1034 1035**返回：** 1036 1037如果API成功，则返回napi_ok。 1038 1039### napi_deserialize 1040 1041```cpp 1042napi_status napi_deserialize(napi_env env, void* buffer, napi_value* object) 1043``` 1044 1045**描述：** 1046 1047将native数据转为ArkTS对象。 1048 1049**参数：** 1050 1051- [in] env: Node-API的环境对象，表示当前的执行环境。 1052 1053- [in] buffer: 指向包含二进制数据的指针。这些二进制数据需要被反序列化为JavaScript对象。 1054 1055- [out] object: 用于接收反序列化后的JavaScript对象。 1056 1057**返回：** 1058 1059如果API成功，则返回napi_ok。 1060 1061### napi_delete_serialization_data 1062 1063```cpp 1064napi_status napi_delete_serialization_data(napi_env env, void* buffer) 1065``` 1066 1067**描述：** 1068 1069删除序列化数据。 1070 1071**参数：** 1072 1073- [in] env: Node-API的环境对象，表示当前的执行环境。 1074 1075- [in] buffer: 指向包含序列化数据的内存缓冲区的指针。这些数据在序列化完成后不再需要，并且可以通过调用此函数来释放相应的内存。 1076 1077**返回：** 1078 1079如果API成功，则返回napi_ok。 1080 1081### napi_call_threadsafe_function_with_priority 1082 1083```cpp 1084napi_status napi_call_threadsafe_function_with_priority(napi_threadsafe_function func, 1085 void *data, 1086 napi_task_priority priority, 1087 bool isTail) 1088``` 1089 1090**描述：** 1091 1092将指定优先级和入队方式的任务投递到ArkTS主线程。 1093 1094**参数：** 1095 1096- [in] func: 线程安全函数对象，在创建线程安全函数时返回。 1097 1098- [in] data: 传递给 JavaScript 回调函数的参数数据。 1099 1100- [in] priority: 指定调用 JavaScript 回调函数的任务优先级。 1101 1102- [in] isTail: 一个布尔值，指示调用是否应该排队等待在事件循环的尾部执行。如果为 true，则调用将在事件循环的尾部执行；如果为 false，则调用将立即执行，不会排队等待。 1103 1104**返回：** 1105 1106如果API成功，则返回napi_ok。 1107 1108### napi_is_sendable 1109 1110```cpp 1111napi_status napi_is_sendable(napi_env env, napi_value value, bool* result) 1112``` 1113 1114**描述：** 1115 1116判断给定JS value是否是Sendable的。 1117 1118**参数：** 1119 1120- [in] env: Node-API的环境对象，表示当前的执行环境。 1121 1122- [in] value: 一个napi_value类型的参数，是需要判断的值。 1123 1124- [out] result: 一个bool类型的指针，用于存储判断结果。 1125 1126**返回：** 1127 1128如果API成功，则返回napi_ok。 1129 1130 1131### napi_define_sendable_class 1132 1133```cpp 1134napi_status napi_define_sendable_class(napi_env env, 1135 const char* utf8name, 1136 size_t length, 1137 napi_callback constructor, 1138 void* data, 1139 size_t property_count, 1140 const napi_property_descriptor* properties, 1141 napi_value parent, 1142 napi_value* result) 1143 1144 1145``` 1146 1147**描述：** 1148 1149创建一个Sendable类。 1150 1151**参数：** 1152 1153- [in] env: Node-API的环境对象，表示当前的执行环境。 1154 1155- [in] utf8name：一个const char*类型的参数，表示类的名称。 1156 1157- [in] length：一个size_t类型的参数，表示类名称的字节数。 1158 1159- [in] constructor：一个napi_callback类型的参数，表示类的构造函数。 1160 1161- [in] data：[可选]一个void*类型的参数，表示构造函数的附加数据。 1162 1163- [in] property_count：一个size_t类型的参数，表示类的属性数量。 1164 1165- [in] properties：[可选]一个const napi_property_descriptor*类型的参数，表示类的属性描述符数组。 1166 1167- [in] parent：[可选]一个napi_value类型的参数，表示父类。 1168 1169- [out] result：一个napi_value类型的指针，用于存储创建的对象。 1170 1171**返回：** 1172 1173如果API成功，则返回napi_ok。 1174 1175### napi_create_sendable_object_with_properties 1176 1177```cpp 1178napi_status napi_create_sendable_object_with_properties(napi_env env, 1179 size_t property_count, 1180 const napi_property_descriptor* properties, 1181 napi_value* result) 1182``` 1183 1184**描述：** 1185 1186使用给定的napi_property_descriptor创建一个Sendable对象。 1187 1188**参数：** 1189 1190- [in] env: Node-API的环境对象，表示当前的执行环境。 1191 1192- [in] property_count：一个size_t类型的参数，表示属性数量。 1193 1194- [in] properties：一个const napi_property_descriptor*类型的参数，表示属性描述符数组。 1195 1196- [out] result：一个napi_value类型的指针，用于存储创建的对象。 1197 1198**返回：** 1199 1200如果API成功，则返回napi_ok。 1201 1202### napi_create_sendable_array 1203 1204```cpp 1205napi_status napi_create_sendable_array(napi_env env, napi_value* result) 1206``` 1207 1208**描述：** 1209 1210创建一个Sendable数组。 1211 1212**参数：** 1213 1214- [in] env: Node-API的环境对象，表示当前的执行环境。 1215 1216- [out] result：一个napi_value类型的指针，用于存储创建的数组。 1217 1218**返回：** 1219 1220如果API成功，则返回napi_ok。 1221 1222### napi_create_sendable_array_with_length 1223 1224```cpp 1225napi_status napi_create_sendable_array_with_length(napi_env env, size_t length, napi_value* result) 1226``` 1227 1228**描述：** 1229 1230创建一个指定长度的Sendable数组。 1231 1232**参数：** 1233 1234- [in] env: Node-API的环境对象，表示当前的执行环境。 1235 1236- [in] length：一个size_t类型的参数，表示数组的长度。 1237 1238- [out] result：一个napi_value类型的指针，用于存储创建的数组。 1239 1240**返回：** 1241 1242如果API成功，则返回napi_ok。 1243 1244### napi_create_sendable_arraybuffer 1245 1246```cpp 1247napi_status napi_create_sendable_arraybuffer(napi_env env, size_t byte_length, void** data, napi_value* result) 1248``` 1249 1250**描述：** 1251 1252创建一个Sendable ArrayBuffer。 1253 1254**参数：** 1255 1256- [in] env: Node-API的环境对象，表示当前的执行环境。 1257 1258- [in] byte_length：要创建的ArrayBuffer的大小。 1259 1260- [in] data：指向底层字节缓冲区的指针。 1261 1262- [out] result：一个napi_value类型的指针，用于存储创建的ArrayBuffer。 1263 1264**返回：** 1265 1266如果API成功，则返回napi_ok。 1267 1268### napi_create_sendable_typedarray 1269 1270```cpp 1271napi_status napi_create_sendable_typedarray(napi_env env, 1272 napi_typedarray_type type, 1273 size_t length, 1274 napi_value arraybuffer, 1275 size_t byte_offset, 1276 napi_value* result); 1277``` 1278 1279**描述：** 1280 1281创建一个Sendable TypedArray。 1282 1283**参数：** 1284 1285- [in] env: Node-API的环境对象，表示当前的执行环境。 1286 1287- [in] type：TypedArray 的类型。 1288 1289- [in] length：TypedArray 的长度。 1290 1291- [in] arraybuffer：一个 ArrayBuffer 实例。 1292 1293- [in] byte_offset：ArrayBuffer 的偏移量。 1294 1295- [out] result：一个napi_value类型的指针，用于存储创建的TypedArray。 1296 1297**返回：** 1298 1299如果API成功，则返回napi_ok。 1300 1301### napi_wrap_sendable 1302 1303```cpp 1304napi_status napi_wrap_sendable(napi_env env, 1305 napi_value js_object, 1306 void* native_object, 1307 napi_finalize finalize_cb, 1308 void* finalize_hint); 1309``` 1310 1311**描述：** 1312 1313包裹一个native实例到ArkTS对象中。 1314 1315**参数：** 1316 1317- [in] env: Node-API的环境对象，表示当前的执行环境。 1318 1319- [in] js_object：ArkTS对象。 1320 1321- [in] native_object：将被包裹在ArkTS对象中的native实例。 1322 1323- [in] napi_finalize：[可选]ArkTS对象被销毁时调用的回调函数。 1324 1325- [in] finalize_hint：[可选]上下文提示，会传递给回调函数。 1326 1327**返回：** 1328 1329如果API成功，则返回napi_ok。 1330 1331### napi_wrap_sendable_with_size 1332 1333```cpp 1334napi_status napi_wrap_sendable_with_size(napi_env env, 1335 napi_value js_object, 1336 void* native_object, 1337 napi_finalize finalize_cb, 1338 void* finalize_hint, 1339 size_t native_binding_size); 1340``` 1341 1342**描述：** 1343 1344包装一个native实例到ArkTS对象中并指定大小。 1345 1346**参数：** 1347 1348- [in] env: Node-API的环境对象，表示当前的执行环境。 1349 1350- [in] js_object：ArkTS对象。 1351 1352- [in] native_object：将被包裹在ArkTS对象中的native实例。 1353 1354- [in] napi_finalize：[可选]ArkTS对象被销毁时调用的回调函数。 1355 1356- [in] finalize_hint：[可选]上下文提示，会传递给回调函数。 1357 1358- [in] native_binding_size：[可选]绑定的native实例的大小。 1359 1360**返回：** 1361 1362如果API成功，则返回napi_ok。 1363 1364### napi_unwrap_sendable 1365 1366```cpp 1367napi_status napi_unwrap_sendable(napi_env env, napi_value js_object, void** result) 1368``` 1369 1370**描述：** 1371 1372获取ArkTS对象包装的native实例。 1373 1374**参数：** 1375 1376- [in] env: Node-API的环境对象，表示当前的执行环境。 1377 1378- [in] js_object：ArkTS对象。 1379 1380- [out] result：包裹在ArkTS对象中的native实例。 1381 1382**返回：** 1383 1384如果API成功，则返回napi_ok。 1385 1386### napi_remove_wrap_sendable 1387 1388```cpp 1389napi_status napi_remove_wrap_sendable(napi_env env, napi_value js_object, void** result) 1390``` 1391 1392**描述：** 1393 1394移除并获取ArkTS对象包装的native实例。 1395 1396**参数：** 1397 1398- [in] env: Node-API的环境对象，表示当前的执行环境。 1399 1400- [in] js_object：ArkTS对象。 1401 1402- [out] result：包裹在ArkTS对象中的native实例。 1403 1404**返回：** 1405 1406如果API成功，则返回napi_ok。 1407 1408<!--no_check-->