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-v10.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|创建出一个可逃逸的handel scope，可将范围内声明的值返回到父作用域。|10| 49|FUNC|napi_close_escapable_handle_scope|关闭传入的可逃逸的handel 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 vaule对应的ISO-8859-1编码的字符串。|10| 83|FUNC|napi_get_value_string_utf8|获取给定js vaule对应的UTF8编码的字符串。|10| 84|FUNC|napi_get_value_string_utf16|获取给定js vaule对应的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 == nullptr时，标准库会返回napi_invalid_arg，而OpenHarmony中未做判断。 186 187- 该导出接口允许code属性设置失败。 188 189### napi_throw_type_error 190 191**返回：** 192 193- 当code == nullptr时，标准库会返回napi_invalid_arg，而OpenHarmony中未做判断。 194 195- 该导出接口允许code属性设置失败。 196 197### napi_throw_range_error 198 199**返回：** 200 201- 当code == nullptr时，标准库会返回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_create_symbol 252 253**返回：** 254 255- 当入参description不为空且不是String对象时，该导出接口返回napi_invalid_arg。 256 257### napi_create_typedarray 258 259**返回：** 260 261- 当入参arraybuffer不为空且不为ArrayBuffer对象时，该导出接口返回napi_arraybuffer_expected。 262 263### napi_create_dataview 264 265**返回：** 266 267- 当入参arraybuffer不为空且不为ArrayBuffer对象时，该导出接口返回napi_arraybuffer_expected。 268 269- 如果byte_offset与byte_length的和大于arraybuffer的大小，该导出接口将会抛出RangeError异常，并返回napi_pending_exception。 270 271### napi_get_typedarray_info 272 273**参数：** 274 275- object: 该导出接口支持TypedArray或[Sendable TypedArray](../apis-arkts/js-apis-arkts-collections.md#collectionstypedarray)类型。 276 277### napi_coerce_to_object 278 279**返回：** 280 281- 当value为undefined或null时，该导出接口返回napi_ok，出参result为undefined。 282 283### napi_instanceof 284 285**返回：** 286 287- 当参数object不是Object对象时，该导出接口直接返回napi_object_expected，result不做处理。 288 289- 当参数constructor不是Function对象时，该导出接口不会抛出异常，接口返回napi_function_expected。 290 291### napi_is_typedarray 292 293**参数：** 294 295- value: 该导出接口额外支持[Sendable TypedArray](../apis-arkts/js-apis-arkts-collections.md#collectionstypedarray)类型。 296 297### napi_get_property_names 298 299**返回：** 300 301- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 302 303### napi_set_property 304 305**返回：** 306 307- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 308 309### napi_get_property 310 311**返回：** 312 313- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 314 315### napi_has_property 316 317**返回：** 318 319- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 320 321### napi_delete_property 322 323**返回：** 324 325- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 326 327### napi_has_own_property 328 329**返回：** 330 331- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 332 333### napi_set_named_property 334 335**返回：** 336 337- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 338 339### napi_get_named_property 340 341**返回：** 342 343- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 344 345### napi_has_named_property 346 347**返回：** 348 349- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 350 351### napi_set_element 352 353**返回：** 354 355- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 356 357### napi_get_element 358 359**返回：** 360 361- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 362 363### napi_has_element 364 365**返回：** 366 367- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 368 369### napi_delete_element 370 371**返回：** 372 373- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 374 375### napi_define_properties 376 377**返回：** 378 379- 当参数object不是Object或Function对象时，该导出接口返回napi_object_expected。 380 381### napi_type_tag_object 382 383**返回：** 384 385- 当参数js_object不是Object或Function对象时，该导出接口返回napi_object_expected。 386 387### napi_check_object_type_tag 388 389**返回：** 390 391- 当参数js_object不是Object或Function对象时，该导出接口返回napi_object_expected。 392 393### napi_call_function 394 395**返回：** 396 397- 该导出接口不会去校验参数recv是否为nullptr。 398 399- 当参数func不是Function对象时，该导出接口返回napi_function_expected。 400 401### napi_new_instance 402 403**返回：** 404 405- 当参数constructor不是Function对象时，该导出接口返回napi_function_expected。 406 407### napi_define_class 408 409**返回：** 410 411- 当length不为NAPI_AUTO_LENGTH且大于INT_MAX时，该导出接口返回napi_object_expected。 412 413### napi_wrap 414 415**返回：** 416 417- 参数js_object不为Object或Function对象时，该导出接口返回napi_object_expected。 418 419### napi_unwrap 420 421**返回：** 422 423- 参数js_object不为Object或Function对象时，该导出接口返回napi_object_expected。 424 425### napi_remove_wrap 426 427**返回：** 428 429- 参数js_object不为Object或Function对象时，该导出接口返回napi_object_expected。 430 431### napi_create_async_work 432 433**参数：** 434 435- 该导出接口暂时不支持async_hooks资源管理机制。 436 437- 该导出接口不会校验入参async_resource_name是否为String类型对象。 438 439- 由于当前暂不支持async_hooks资源管理机制，入参async_resource暂时也不做处理。 440 441### napi_delete_async_work 442 443**参数：** 444 445- 该导出接口暂时不支持async_hooks资源管理机制。 446 447### napi_queue_async_work 448 449**参数：** 450 451- 该导出接口暂时不支持async_hooks资源管理机制。 452 453### napi_cancel_async_work 454 455**返回：** 456 457- 若因为底层uv导致取消任务失败，标准库会根据失败原因，返回napi_generic_failure或napi_invalid_arg或napi_cancelled，而在OpenHarmony上该导出接口不会去校验uv的返回值，开发者可以根据相关的日志去排查任务是否取消失败。 458 459### napi_async_init 460 461**说明：** 462 463- OpenHarmony暂不支持async_hooks资源管理机制。目前未实现与async_hooks交互的内容，该接口调用后并不会有async_hooks的相关操作。 464 465### napi_make_callback 466 467**说明：** 468 469- OpenHarmony暂不支持async_hooks资源管理机制。目前未实现与async_hooks交互的内容，该接口调用后并不会有async_hooks的相关操作。 470 471### napi_async_destroy 472 473**说明：** 474 475- OpenHarmony暂不支持async_hooks资源管理机制。目前未实现与async_hooks交互的内容，接口调用后并不会有async_hooks的相关操作。 476 477### napi_get_node_version 478 479**说明：** 480 481- OpenHarmony不需要获取node的版本，故当前该导出接口为空实现。 482 483### napi_resolve_deferred 484 485**说明：** 486 487- promise的then方法的resolve或者reject回调中出现异常时，如果promise没有catch块，代码会继续执行不会崩溃；如果promise有catch块，则异常会被该catch块捕获。 488 489### napi_reject_deffered 490 491**说明：** 492 493- promise的then方法的resolve或者reject回调中出现异常时，如果promise没有catch块，代码会继续执行不会崩溃；如果promise有catch块，则异常会被该catch块捕获。 494 495### napi_create_threadsafe_function 496 497**参数：** 498 499- initial_thread_count: OpenHarmony中上限为128。 500 501- async_resource: OpenHarmony中不做类型限制。 502 503- async_resource_name: OpenHarmony中不做类型限制。 504 505- func: OpenHarmony中不做类型限制。 506 507**说明：** 508 509- OpenHarmony中，创建线程安全函数的过程中没有注册cleanup hook方法，如有需要可以调用napi_add_env_cleanup_hook。 510 511### napi_call_threadsafe_function 512 513**说明：** 514 515- OpenHarmony调用uv_async_send接口前会检查env是否存活。 516 517- 调用uv_async_send接口失败时，OpenHarmony中会返回napi_generic_failure。 518 519### napi_release_threadsafe_function 520 521**说明：** 522 523- OpenHarmony调用uv_async_send接口前会检查env是否存活。 524 525- ThreadCount为0时，OpenHarmony中会返回napi_generic_failure。 526 527### napi_ref_threadsafe_function 528 529**说明：** 530 531- OpenHarmony中有校验func和env是否为同一ArkTS线程的过程，若不是同一线程则会返回napi_generic_failure。 532 533### napi_unref_threadsafe_function 534 535**说明：** 536 537- OpenHarmony中有校验func和env是否为同一ArkTS线程的过程，若不是同一线程则会返回napi_generic_failure。 538 539### napi_create_date 540 541**返回：** 542 543- 当入参正常但date创建失败时，标准库中返回napi_generic_failure，而OpenHarmony中将会抛出异常，并且接口返回napi_pending_exception。 544 545### napi_create_bigint_words 546 547**返回：** 548 549- 当入参正常但bigInt创建失败时，标准库中返回napi_generic_failure，而OpenHarmony中将会抛出异常，并且接口返回napi_pending_exception。 550 551### napi_get_value_bigint_words 552 553**返回：** 554 555- 当参数value不是BigInt对象时，OpenHarmony中返回napi_object_expected。 556 557### napi_create_buffer 558 559**返回：** 560 561- OpenHarmony中创建的buffer类型为ArrayBufferLike。 562 563- OpenHarmony中，size为0时返回napi_invalid_arg。 564 565- OpenHarmony中，size大于2097152时返回napi_invalid_arg并打印错误日志。 566 567- OpenHarmony中，data为nullptr时返回napi_invalid_arg。 568 569- 标准库中，进入或退出接口前若有异常将直接返回napi_pending_exception，OpenHarmony中没有对此做校验。 570 571### napi_create_buffer_copy 572 573**返回：** 574 575- OpenHarmony中创建的buffer类型为ArrayBufferLike。 576 577- OpenHarmony中，size为0时返回napi_invalid_arg。 578 579- OpenHarmony中，size大于2097152时返回napi_invalid_arg并打印错误日志。 580 581- OpenHarmony中，data为nullptr时返回napi_invalid_arg。 582 583- 标准库中，进入或退出接口前若有异常将直接返回napi_pending_exception，OpenHarmony中没有对此做校验。 584 585### napi_create_external_buffer 586 587**返回：** 588 589- OpenHarmony中创建的buffer类型为ArrayBufferLike。 590 591- OpenHarmony中，size为0时返回napi_invalid_arg。 592 593- OpenHarmony中，size大于2097152时返回napi_invalid_arg并打印错误日志。 594 595- 标准库中，因未知原因导致创建失败时将返回napi_generic_failure，OpenHarmony中返回napi_pending_exception。 596 597### napi_get_buffer_info 598 599**返回：** 600 601- OpenHarmony会对value是否属于buffer进行判断，若不属于则返回napi_arraybuffer_expected。 602 603### napi_detach_arraybuffer 604 605**返回：** 606 607- 当入参arraybuffer不为Object对象时，该导出接口返回napi_object_expected；当arraybuffer是Object对象但不为ArrayBuffer对象时，该导出接口返回napi_invalid_arg。 608 609### napi_add_env_cleanup_hook 610 611**说明：** 612 613- data已注册到env中时，OpenHarmony仅打印异常日志。 614 615### napi_add_finalizer 616 617**返回：** 618 619- 入参js_object不是Object对象时，OpenHarmony中该导出接口返回napi_object_expected。 620 621**说明：** 622 623- OpenHarmony中，当强引用delete时直接进行回调，无需等到对象析构。 624 625- 回调主动抛出异常时，OpenHarmony会触发JSCrash。 626 627### napi_fatal_exception 628 629**参数：** 630 631- err: OpenHarmony中仅支持Error类型，类型不匹配将返回napi_invalid_arg。 632 633### napi_get_uv_event_loop 634 635**返回：** 636 637- 参数env不是有效的napi_env（例如此env已被释放）时，该导出接口返回napi_generic_failure。 638 639## 未从Node-API组件标准库中导出的符号列表 640 641|符号类型|符号名|说明| 642| --- | --- | --- | 643|FUNC|napi_adjust_external_memory|调整js `Object`持有的外部内存。| 644 645## Node-API组件扩展的符号列表 646 647|符号类型|符号名|说明|起始支持API版本| 648| --- | --- | --- | --- | 649|FUNC|napi_queue_async_work_with_qos|将异步工作对象加到队列，由底层根据传入的qos优先级去调度执行。|10| 650|FUNC|napi_run_script_path|运行abc文件。|10| 651|FUNC|napi_load_module|将abc文件作为模块加载，返回模块的命名空间。|11| 652|FUNC|napi_create_object_with_properties|使用给定的napi_property_descriptor创建js `Object`。descriptor的键名必须为 string，且不可转为number。|11| 653|FUNC|napi_create_object_with_named_properties|使用给定的napi_value和键名创建js `Object`。键名必须为 string，且不可转为number。|11| 654|FUNC|napi_coerce_to_native_binding_object|强制将js `Object`和Native对象绑定。|11| 655|FUNC|napi_create_ark_runtime|创建基础运行时环境。|12| 656|FUNC|napi_destroy_ark_runtime|销毁基础运行时环境。|12| 657|FUNC|napi_run_event_loop|触发底层的事件循环。|12| 658|FUNC|napi_stop_event_loop|停止底层的事件循环。|12| 659|FUNC|napi_load_module_with_info|将abc文件作为模块加载，返回模块的命名空间。可在新创建的ArkTS基础运行时环境中使用。|12| 660|FUNC|napi_serialize|将ArkTS对象转换为native数据。|12| 661|FUNC|napi_deserialize|将native数据转为ArkTS对象。|12| 662|FUNC|napi_delete_serialization_data|删除序列化数据。|12| 663|FUNC|napi_call_threadsafe_function_with_priority|将指定优先级和入队方式的任务投递到ArkTS主线程。|12| 664|FUNC|napi_is_sendable|判断给定JS value是否是Sendable的。|12| 665|FUNC|napi_define_sendable_class|创建一个Sendable类。|12| 666|FUNC|napi_create_sendable_object_with_properties | 使用给定的napi_property_descriptor创建一个Sendable对象。|12| 667|FUNC|napi_create_sendable_array | 创建一个Sendable数组。|12| 668|FUNC|napi_create_sendable_array_with_length | 创建一个指定长度的Sendable数组。|12| 669|FUNC|napi_create_sendable_arraybuffer | 创建一个Sendable ArrayBuffer。|12| 670|FUNC|napi_create_sendable_typedarray | 创建一个Sendable TypedArray。|12| 671|FUNC|napi_wrap_sendable | 包裹一个native实例到ArkTS对象中。|12| 672|FUNC|napi_wrap_sendable_with_size | 包裹一个native实例到ArkTS对象中并指定大小。|12| 673|FUNC|napi_unwrap_sendable | 获取ArkTS对象包裹的native实例。|12| 674|FUNC|napi_remove_wrap_sendable | 移除并获取ArkTS对象包裹的native实例。|12| 675 676> 说明： 677> 678> 有关Sendable特性的介绍，详见[Sendable开发指导](../../arkts-utils/arkts-sendable.md)。 679 680### napi_qos_t 681 682```cpp 683typedef enum { 684 napi_qos_background = 0, // 低等级，用户不可见任务，例如数据同步、备份。 685 napi_qos_utility = 1, // 中低等级，不需要立即看到响应效果的任务，例如下载或导入数据。 686 napi_qos_default = 2, // 默认 687 napi_qos_user_initiated = 3, // 高等级，用户触发并且可见进展，例如打开文档。 688} napi_qos_t; 689``` 690 691**描述：** 692表示QoS的枚举值，QoS决定了线程调度的优先级 693 694### napi_event_mode 695 696```cpp 697typedef enum { 698 napi_event_mode_default = 0, // 阻塞式的运行底层事件循环，直到循环中没有任何任务时退出事件循环。 699 napi_event_mode_nowait = 1, // 非阻塞式的运行底层事件循环，尝试去处理一个任务，处理完之后退出事件循环；如果事件循环中没有任务，立刻退出事件循环。 700} napi_event_mode; 701``` 702 703**描述：** 704用于运行事件循环的事件模式。 705 706### napi_queue_async_work_with_qos 707 708```cpp 709napi_status napi_queue_async_work_with_qos(napi_env env, 710 napi_async_work work, 711 napi_qos_t qos); 712``` 713 714**描述：** 715 716将异步工作对象加到队列，由底层根据传入的qos优先级去调度执行。 717 718**参数：** 719 720- [in] env: Node-API的环境对象，表示当前的执行环境。 721 722- [in] work: 一个表示异步工作项的对象。这个对象通常是通过napi_create_async_work函数创建的。 723 724- [in] qos: 决定了线程调度的优先级。 725 726**返回：** 727 728如果API成功，则返回napi_ok。 729 730### napi_run_script_path 731 732```cpp 733napi_status napi_run_script_path(napi_env env, 734 const char* abcPath, 735 napi_value* result); 736``` 737 738**描述：** 739 740运行指定abc文件。 741 742**参数：** 743 744- [in] env: Node-API的环境对象，表示当前的执行环境。 745 746- [in] abcPath: 要运行的脚本的JavaScript路径。这是一个字符串，指定了要运行的脚本文件的位置。 747 748- [out] result: 一个指向napi_value类型的指针，用于存储运行脚本的结果。 749 750**返回：** 751 752如果API成功，则返回napi_ok。 753 754### napi_load_module 755 756```cpp 757napi_status napi_load_module(napi_env env, 758 const char* path, 759 napi_value* result); 760``` 761 762**描述：** 763 764加载系统模块或开发者自定义的模块，返回模块的命名空间。 765 766**参数：** 767 768- [in] env: Node-API的环境对象，表示当前的执行环境。 769 770- [in] path: 要加载的系统模块的名称或开发者自定义模块的路径。 771 772- [out] result: 一个指向napi_value类型的指针，用于存储加载模块的结果。 773 774**返回：** 775 776如果API成功，则返回napi_ok。 777 778### napi_create_object_with_properties 779 780```cpp 781napi_status napi_create_object_with_properties(napi_env env, 782 napi_value* result, 783 size_t property_count, 784 const napi_property_descriptor* properties); 785``` 786 787**描述：** 788 789属性描述符napi_property_descriptor用于描述一个属性，它包括属性的名称获取和设置方法、属性特性等信息。通过传入这些描述符，可以在创建对象时就定义属性。 790 791使用给定的napi_property_descriptor创建js Object。descriptor的键名必须为string，且不可转为number。 792 793**参数：** 794 795- [in] env: Node-API的环境对象，表示当前的执行环境。 796 797- [out] result: 一个指向napi_value类型的指针，用于存储创建的对象。 798 799- [in] property_count: 要添加到对象中的属性的数量。 800 801- [in] properties: 一个指向napi_property_descriptor数组的指针，描述了要添加到对象中的属性的信息。 802 803**返回：** 804 805如果API成功，则返回napi_ok。 806 807### napi_create_object_with_named_properties 808 809```cpp 810napi_status napi_create_object_with_named_properties(napi_env env, 811 napi_value* result, 812 size_t property_count, 813 const char** keys, 814 const napi_value* values); 815``` 816 817**描述：** 818 819使用给定的napi_value和键名创建js Object。键名必须为string，且不可转为number。 820 821**参数：** 822 823- [in] env: Node-API的环境对象，表示当前的执行环境。 824 825- [out] result: 一个指向napi_value类型的指针，用于存储创建的对象。 826 827- [in] property_count: 要添加到对象中的属性的数量。 828 829- [in] keys: 一个指向const char*数组的指针，表示属性的名称。 830 831- [in] values: 一个指向napi_value数组的指针，表示属性的值，与属性名称一一对应。 832 833**返回：** 834 835如果API成功，则返回napi_ok。 836 837### napi_coerce_to_native_binding_object 838 839```cpp 840napi_status napi_coerce_to_native_binding_object(napi_env env, 841 napi_value js_object, 842 napi_native_binding_detach_callback detach_cb, 843 napi_native_binding_attach_callback attach_cb, 844 void* native_object, 845 void* hint); 846``` 847 848**描述：** 849 850用于给JS Object绑定回调和回调所需的参数，转成携带Native信息的JS Object。 851 852**参数：** 853 854- [in] env: Node-API的环境对象，表示当前的执行环境。 855 856- [in] js_object: 要转换的JavaScript对象。 857 858- [in] detach_cb: 解绑回调，一般在序列化时调用，可在对象解绑时执行一些清理操作。 859 860- [in] attach_cb: 绑定回调，一般在序列化时调用。 861 862- [in] native_object: 需要传递给回调的参数，不能为空。 863 864- [in] hint: 一个指针，可以用于传递附加的信息给回调函数。 865 866**返回：** 867 868如果API成功，则返回napi_ok。 869 870### napi_create_ark_runtime 871 872```cpp 873napi_status napi_create_ark_runtime(napi_env *env) 874``` 875 876**描述：** 877 878创建基础运行时环境。 879 880**参数：** 881 882- [in] env: Node-API的环境对象，表示当前的执行环境。 883 884**返回：** 885 886如果API成功，则返回napi_ok。 887 888### napi_destroy_ark_runtime 889 890```cpp 891napi_status napi_destroy_ark_runtime(napi_env *env) 892``` 893 894**描述：** 895 896销毁基础运行时环境。 897 898**参数：** 899 900- [in] env: Node-API的环境对象，表示当前的执行环境。 901 902**返回：** 903 904如果API成功，则返回napi_ok。 905 906### napi_run_event_loop 907 908```cpp 909napi_status napi_run_event_loop(napi_env env, napi_event_mode mode) 910``` 911 912**描述：** 913 914触发底层的事件循环。 915 916**参数：** 917 918- [in] env: Node-API的环境对象，表示当前的执行环境。 919- [in] mode: 用于运行事件循环的事件模式。 920 921**返回：** 922 923如果API成功，则返回napi_ok。 924 925### napi_stop_event_loop 926 927```cpp 928napi_status napi_stop_event_loop(napi_env env) 929``` 930 931**描述：** 932 933停止底层的事件循环。 934 935**参数：** 936 937- [in] env: Node-API的环境对象，表示当前的执行环境。 938 939**返回：** 940 941如果API成功，则返回napi_ok。 942 943### napi_load_module_with_info 944 945```cpp 946napi_status napi_load_module_with_info(napi_env env, 947 const char* path, 948 const char* module_info, 949 napi_value* result) 950``` 951 952**描述：** 953 954将abc文件作为模块加载，返回模块的命名空间。可在新创建的ArkTS基础运行时环境中使用。 955 956**参数：** 957 958- [in] env: Node-API的环境对象，表示当前的执行环境。 959 960- [in] path: 要加载的模块的路径。 961 962- [in] module_info: 模块信息。这是一个包含模块信息字符串。模块信息可以用于指定模块的版本、作者、描述等详细信息。 963 964- [out] result: 指向napi_value的指针，用于接收模块的结果。 965 966**返回：** 967 968如果API成功，则返回napi_ok。 969 970### napi_serialize 971 972```cpp 973napi_status napi_serialize(napi_env env, 974 napi_value object, 975 napi_value transfer_list, 976 napi_value clone_list, 977 void** result) 978``` 979 980**描述：** 981 982将ArkTS对象转换为native数据。 983 984**参数：** 985 986- [in] env: Node-API的环境对象，表示当前的执行环境。 987 988- [in] object: 要序列化的JavaScript对象。 989 990- [in] transfer_list: 传输列表，包含需要在序列化过程中转移的JavaScript对象。 991 992- [in] clone_list: 克隆列表，包含需要在序列化过程中克隆的JavaScript对象。 993 994- [out] result: 用于接收序列化结果的指针。在调用完成后，指向实际结果的指针会存储在此位置。 995 996**返回：** 997 998如果API成功，则返回napi_ok。 999 1000### napi_deserialize 1001 1002```cpp 1003napi_status napi_deserialize(napi_env env, void* buffer, napi_value* object) 1004``` 1005 1006**描述：** 1007 1008将native数据转为ArkTS对象。 1009 1010**参数：** 1011 1012- [in] env: Node-API的环境对象，表示当前的执行环境。 1013 1014- [in] buffer: 指向包含二进制数据的指针。这些二进制数据需要被反序列化为JavaScript对象。 1015 1016- [out] object: 用于接收反序列化后的JavaScript对象。 1017 1018**返回：** 1019 1020如果API成功，则返回napi_ok。 1021 1022### napi_delete_serialization_data 1023 1024```cpp 1025napi_status napi_delete_serialization_data(napi_env env, void* buffer) 1026``` 1027 1028**描述：** 1029 1030删除序列化数据。 1031 1032**参数：** 1033 1034- [in] env: Node-API的环境对象，表示当前的执行环境。 1035 1036- [in] buffer: 指向包含序列化数据的内存缓冲区的指针。这些数据在序列化完成后不再需要，并且可以通过调用此函数来释放相应的内存。 1037 1038**返回：** 1039 1040如果API成功，则返回napi_ok。 1041 1042### napi_call_threadsafe_function_with_priority 1043 1044```cpp 1045napi_status napi_call_threadsafe_function_with_priority(napi_threadsafe_function func, 1046 void *data, 1047 napi_task_priority priority, 1048 bool isTail) 1049``` 1050 1051**描述：** 1052 1053将指定优先级和入队方式的任务投递到ArkTS主线程。 1054 1055**参数：** 1056 1057- [in] func: 线程安全函数对象，在创建线程安全函数时返回。 1058 1059- [in] data: 传递给 JavaScript 回调函数的参数数据。 1060 1061- [in] priority: 指定调用 JavaScript 回调函数的任务优先级。 1062 1063- [in] isTail: 一个布尔值，指示调用是否应该排队等待在事件循环的尾部执行。如果为 true，则调用将在事件循环的尾部执行；如果为 false，则调用将立即执行，不会排队等待。 1064 1065**返回：** 1066 1067如果API成功，则返回napi_ok。 1068 1069### napi_is_sendable 1070 1071```cpp 1072napi_status napi_is_sendable(napi_env env, napi_value value, bool* result) 1073``` 1074 1075**描述：** 1076 1077判断给定JS value是否是Sendable的。 1078 1079**参数：** 1080 1081- [in] env: Node-API的环境对象，表示当前的执行环境。 1082 1083- [in] value: 一个napi_value类型的参数，是需要判断的值。 1084 1085- [out] result: 一个bool类型的指针，用于存储判断结果。 1086 1087**返回：** 1088 1089如果API成功，则返回napi_ok。 1090 1091 1092### napi_define_sendable_class 1093 1094```cpp 1095napi_status napi_define_sendable_class(napi_env env, 1096 const char* utf8name, 1097 size_t length, 1098 napi_callback constructor, 1099 void* data, 1100 size_t property_count, 1101 const napi_property_descriptor* properties, 1102 napi_value parent, 1103 napi_value* result) 1104 1105 1106``` 1107 1108**描述：** 1109 1110创建一个Sendable类。 1111 1112**参数：** 1113 1114- [in] env: Node-API的环境对象，表示当前的执行环境。 1115 1116- [in] utf8name：一个const char*类型的参数，表示类的名称。 1117 1118- [in] length：一个size_t类型的参数，表示类名称的字节数。 1119 1120- [in] constructor：一个napi_callback类型的参数，表示类的构造函数。 1121 1122- [in] data：[可选]一个void*类型的参数，表示构造函数的附加数据。 1123 1124- [in] property_count：一个size_t类型的参数，表示类的属性数量。 1125 1126- [in] properties：[可选]一个const napi_property_descriptor*类型的参数，表示类的属性描述符数组。 1127 1128- [in] parent：[可选]一个napi_value类型的参数，表示父类。 1129 1130- [out] result：一个napi_value类型的指针，用于存储创建的对象。 1131 1132**返回：** 1133 1134如果API成功，则返回napi_ok。 1135 1136### napi_create_sendable_object_with_properties 1137 1138```cpp 1139napi_status napi_create_sendable_object_with_properties(napi_env env, 1140 size_t property_count, 1141 const napi_property_descriptor* properties, 1142 napi_value* result) 1143``` 1144 1145**描述：** 1146 1147使用给定的napi_property_descriptor创建一个Sendable对象。 1148 1149**参数：** 1150 1151- [in] env: Node-API的环境对象，表示当前的执行环境。 1152 1153- [in] property_count：一个size_t类型的参数，表示属性数量。 1154 1155- [in] properties：一个const napi_property_descriptor*类型的参数，表示属性描述符数组。 1156 1157- [out] result：一个napi_value类型的指针，用于存储创建的对象。 1158 1159**返回：** 1160 1161如果API成功，则返回napi_ok。 1162 1163### napi_create_sendable_array 1164 1165```cpp 1166napi_status napi_create_sendable_array(napi_env env, napi_value* result) 1167``` 1168 1169**描述：** 1170 1171创建一个Sendable数组。 1172 1173**参数：** 1174 1175- [in] env: Node-API的环境对象，表示当前的执行环境。 1176 1177- [out] result：一个napi_value类型的指针，用于存储创建的数组。 1178 1179**返回：** 1180 1181如果API成功，则返回napi_ok。 1182 1183### napi_create_sendable_array_with_length 1184 1185```cpp 1186napi_status napi_create_sendable_array_with_length(napi_env env, size_t length, napi_value* result) 1187``` 1188 1189**描述：** 1190 1191创建一个指定长度的Sendable数组。 1192 1193**参数：** 1194 1195- [in] env: Node-API的环境对象，表示当前的执行环境。 1196 1197- [in] length：一个size_t类型的参数，表示数组的长度。 1198 1199- [out] result：一个napi_value类型的指针，用于存储创建的数组。 1200 1201**返回：** 1202 1203如果API成功，则返回napi_ok。 1204 1205### napi_create_sendable_arraybuffer 1206 1207```cpp 1208napi_status napi_create_sendable_arraybuffer(napi_env env, size_t byte_length, void** data, napi_value* result) 1209``` 1210 1211**描述：** 1212 1213创建一个Sendable ArrayBuffer。 1214 1215**参数：** 1216 1217- [in] env: Node-API的环境对象，表示当前的执行环境。 1218 1219- [in] byte_length：要创建的ArrayBuffer的大小。 1220 1221- [in] data：指向底层字节缓冲区的指针。 1222 1223- [out] result：一个napi_value类型的指针，用于存储创建的ArrayBuffer。 1224 1225**返回：** 1226 1227如果API成功，则返回napi_ok。 1228 1229### napi_create_sendable_typedarray 1230 1231```cpp 1232napi_status napi_create_sendable_typedarray(napi_env env, 1233 napi_typedarray_type type, 1234 size_t length, 1235 napi_value arraybuffer, 1236 size_t byte_offset, 1237 napi_value* result); 1238``` 1239 1240**描述：** 1241 1242创建一个Sendable TypedArray。 1243 1244**参数：** 1245 1246- [in] env: Node-API的环境对象，表示当前的执行环境。 1247 1248- [in] type：TypedArray 的类型。 1249 1250- [in] length：TypedArray 的长度。 1251 1252- [in] arraybuffer：一个 ArrayBuffer 实例。 1253 1254- [in] byte_offset：ArrayBuffer 的偏移量。 1255 1256- [out] result：一个napi_value类型的指针，用于存储创建的TypedArray。 1257 1258**返回：** 1259 1260如果API成功，则返回napi_ok。 1261 1262### napi_wrap_sendable 1263 1264```cpp 1265napi_status napi_wrap_sendable(napi_env env, 1266 napi_value js_object, 1267 void* native_object, 1268 napi_finalize finalize_cb, 1269 void* finalize_hint); 1270``` 1271 1272**描述：** 1273 1274包裹一个native实例到ArkTS对象中。 1275 1276**参数：** 1277 1278- [in] env: Node-API的环境对象，表示当前的执行环境。 1279 1280- [in] js_object：ArkTS对象。 1281 1282- [in] native_object：将被包裹在ArkTS对象中的native实例。 1283 1284- [in] napi_finalize：[可选]ArkTS对象被销毁时调用的回调函数。 1285 1286- [in] finalize_hint：[可选]上下文提示，会传递给回调函数。 1287 1288**返回：** 1289 1290如果API成功，则返回napi_ok。 1291 1292### napi_wrap_sendable_with_size 1293 1294```cpp 1295napi_status napi_wrap_sendable_with_size(napi_env env, 1296 napi_value js_object, 1297 void* native_object, 1298 napi_finalize finalize_cb, 1299 void* finalize_hint, 1300 size_t native_binding_size); 1301``` 1302 1303**描述：** 1304 1305包装一个native实例到ArkTS对象中并指定大小。 1306 1307**参数：** 1308 1309- [in] env: Node-API的环境对象，表示当前的执行环境。 1310 1311- [in] js_object：ArkTS对象。 1312 1313- [in] native_object：将被包裹在ArkTS对象中的native实例。 1314 1315- [in] napi_finalize：[可选]ArkTS对象被销毁时调用的回调函数。 1316 1317- [in] finalize_hint：[可选]上下文提示，会传递给回调函数。 1318 1319- [in] native_binding_size：[可选]绑定的native实例的大小。 1320 1321**返回：** 1322 1323如果API成功，则返回napi_ok。 1324 1325### napi_unwrap_sendable 1326 1327```cpp 1328napi_status napi_unwrap_sendable(napi_env env, napi_value js_object, void** result) 1329``` 1330 1331**描述：** 1332 1333获取ArkTS对象包装的native实例。 1334 1335**参数：** 1336 1337- [in] env: Node-API的环境对象，表示当前的执行环境。 1338 1339- [in] js_object：ArkTS对象。 1340 1341- [out] result：包裹在ArkTS对象中的native实例。 1342 1343**返回：** 1344 1345如果API成功，则返回napi_ok。 1346 1347### napi_remove_wrap_sendable 1348 1349```cpp 1350napi_status napi_remove_wrap_sendable(napi_env env, napi_value js_object, void** result) 1351``` 1352 1353**描述：** 1354 1355移除并获取ArkTS对象包装的native实例。 1356 1357**参数：** 1358 1359- [in] env: Node-API的环境对象，表示当前的执行环境。 1360 1361- [in] js_object：ArkTS对象。 1362 1363- [out] result：包裹在ArkTS对象中的native实例。 1364 1365**返回：** 1366 1367如果API成功，则返回napi_ok。 1368 1369<!--no_check-->