Node-API

简介

Node-API是用于封装JavaScript能力为Native插件的API，独立于底层JavaScript，并作为Node.js的一部分。

支持的能力

Node-API可以去除底层的JavaScript引擎的差异，提供一套稳定的接口。

OpenHarmony的N-API组件对Node-API的接口进行了重新实现，底层对接了ArkJS等引擎。当前支持Node-API标准库中的部分接口。

N-API组件标准库中导出的符号列表

符号类型 符号名 说明
FUNC napi_module_register napi native模块注册接口。
FUNC napi_get_last_error_info 获取napi_extended_error_info结构体，其中包含最近一次出现的error信息。
FUNC napi_throw 抛出一个js value。
FUNC napi_throw_error 抛出一个带文本信息的js Error。
FUNC napi_throw_type_error 抛出一个带文本信息的js TypeError。
FUNC napi_throw_range_error 抛出一个带文本信息的js RangeError。
FUNC napi_is_error 判断napi_value是否表示为一个error对象。
FUNC napi_create_error 创建并获取一个带文本信息的js Error。
FUNC napi_create_type_error 创建并获取一个带文本信息的js TypeError。
FUNC napi_create_range_error 创建并获取一个带文本信息的js RangeError。
FUNC napi_get_and_clear_last_exception 获取并清除最近一次出现的异常。
FUNC napi_is_exception_pending 判断是否出现了异常。
FUNC napi_fatal_error 引发致命错误以立即终止进程。
FUNC napi_open_handle_scope 创建一个上下文环境使用。
FUNC napi_close_handle_scope 关闭传入的上下文环境，关闭后，全部在其中声明的引用都将被关闭。
FUNC napi_open_escapable_handle_scope 创建出一个可逃逸的handel scope，可将范围内声明的值返回到父作用域。
FUNC napi_close_escapable_handle_scope 关闭传入的可逃逸的handel scope。
FUNC napi_escape_handle 提升传入的js object的生命周期到其父作用域。
FUNC napi_create_reference 为Object创建一个reference，以延长其生命周期。调用者需要自己管理reference生命周期。
FUNC napi_delete_reference 删除传入的reference。
FUNC napi_reference_ref 增加传入的reference的引用计数，并获取该计数。
FUNC napi_reference_unref 减少传入的reference的引用计数，并获取该计数。
FUNC napi_get_reference_value 获取与reference相关联的js Object。
FUNC napi_create_array 创建并获取一个js Array。
FUNC napi_create_array_with_length 创建并获取一个指定长度的js Array。
FUNC napi_create_arraybuffer 创建并获取一个指定大小的js ArrayBuffer。
FUNC napi_create_external 分配一个附加有外部数据的js value。
FUNC napi_create_external_arraybuffer 分配一个附加有外部数据的js ArrayBuffer。
FUNC napi_create_object 创建一个默认的js Object。
FUNC napi_create_symbol 创建一个js Symbol。
FUNC napi_create_typedarray 通过现有的ArrayBuffer创建一个js TypeArray。
FUNC napi_create_dataview 通过现有的ArrayBuffer创建一个js DataView。
FUNC napi_create_int32 通过一个C的int32_t数据创建js Number。
FUNC napi_create_uint32 通过一个C的uint32_t数据创建js Number。
FUNC napi_create_int64 通过一个C的int64_t数据创建js Number。
FUNC napi_create_double 通过一个C的double数据创建js Number。
FUNC napi_create_string_latin1 通过ISO-8859-1编码的C字符串数据创建js String。
FUNC napi_create_string_utf8 通过UTF8编码的C字符串数据创建js String。
FUNC napi_create_string_utf16 通过UTF16编码的C字符串数据创建js String。
FUNC napi_get_array_length 获取array的length。
FUNC napi_get_arraybuffer_info 获取ArrayBuffer的底层data buffer及其长度。
FUNC napi_get_prototype 获取给定js Object的prototype。
FUNC napi_get_typedarray_info 获取给定TypedArray的各种属性。
FUNC napi_get_dataview_info 获取给定DataView的各种属性。
FUNC napi_get_value_bool 获取给定js Boolean对应的C bool值。
FUNC napi_get_value_double 获取给定js Number对应的C double值。
FUNC napi_get_value_external 获取先前通过napi_create_external()传递的外部数据指针。
FUNC napi_get_value_int32 获取给定js Number对应的C int32值。
FUNC napi_get_value_int64 获取给定js Number对应的C int64值。
FUNC napi_get_value_string_latin1 获取给定js vaule对应的ISO-8859-1编码的字符串。
FUNC napi_get_value_string_utf8 获取给定js vaule对应的UTF8编码的字符串。
FUNC napi_get_value_string_utf16 获取给定js vaule对应的UTF16编码的字符串。
FUNC napi_get_value_uint32 获取给定js Number对应的C uint32值。
FUNC napi_get_boolean 根据给定的C boolean值，获取js bool对象。
FUNC napi_get_global 获取global对象。
FUNC napi_get_null 获取null对象。
FUNC napi_get_undefined 获取undefined对象。
FUNC napi_coerce_to_bool 将给定的js value强转成js Boolean。
FUNC napi_coerce_to_number 将给定的js value强转成js Number。
FUNC napi_coerce_to_object 将给定的js value强转成js Object。
FUNC napi_coerce_to_string 将给定的js value强转成js String。
FUNC napi_typeof 获取给定js value的js type。
FUNC napi_instanceof 判断给定object是否为给定constructor的实例。
FUNC napi_is_array 判断给定js value是否为array。
FUNC napi_is_arraybuffer 判断给定js value是否为ArrayBuffer。
FUNC napi_is_typedarray 判断给定js value是否表示一个TypedArray。
FUNC napi_is_dataview 判断给定js value是否表示一个DataView。
FUNC napi_is_date 判断给定js value是否为js Date对象。
FUNC napi_strict_equals 判断给定的两个js value是否严格相等。
FUNC napi_get_property_names 以字符串数组的形式获取对象的可枚举属性的名称。
FUNC napi_set_property 对给定Object设置属性。
FUNC napi_get_property 获取给定Object的给定属性。
FUNC napi_has_property 判断给定对象中是否存在给定属性。
FUNC napi_delete_property 尝试从给定Object中删除给定key属性。
FUNC napi_has_own_property 判断给定Object中是否有名为key的own property。
FUNC napi_set_named_property 对给定Object设置一个给定名称的属性。
FUNC napi_get_named_property 获取给定Object中指定名称的属性。
FUNC napi_has_named_property 判断给定Object中是否有给定名称的属性。
FUNC napi_set_element 在给定Object的指定索引处，设置元素。
FUNC napi_get_element 获取给定Object指定索引处的元素。
FUNC napi_has_element 若给定Object的指定索引处拥有属性，获取该元素。
FUNC napi_delete_element 尝试删除给定Object的指定索引处的元素。
FUNC napi_define_properties 批量的向给定Object中定义属性。
FUNC napi_type_tag_object 将tag指针的值与Object关联。
FUNC napi_check_object_type_tag 判断给定的tag指针是否被关联到了js Object上。
FUNC napi_call_function 在Native方法中调用js function，即native call js。
FUNC napi_create_function 创建native方法给js使用，以便于js call native。
FUNC napi_get_cb_info 从给定的callback info中获取有关调用的详细信息，如参数和this指针。
FUNC napi_get_new_target 获取构造函数调用的new.target。
FUNC napi_new_instance 通过给定的构造函数，构建一个实例。
FUNC napi_define_class 定义与C++类相对应的JavaScript类。
FUNC napi_wrap 在js object上绑定一个native对象实例。
FUNC napi_unwrap 从js object上获取先前绑定的native对象实例。
FUNC napi_remove_wrap 从js object上获取先前绑定的native对象实例，并解除绑定。
FUNC napi_create_async_work 创建一个异步工作对象。
FUNC napi_delete_async_work 释放先前创建的异步工作对象。
FUNC napi_queue_async_work 将异步工作对象加到队列，由底层去调度执行。
FUNC napi_cancel_async_work 取消入队的异步任务。
FUNC napi_get_node_version 获取node的版本信息。
FUNC napi_get_version 获取Node运行时支持的最高 N-API 版本。
FUNC napi_create_promise 创建一个延迟对象和js promise。
FUNC napi_resolve_deferred resolve与js promise对象关联的延迟函数。
FUNC napi_reject_deferred reject与js promise对象关联的延迟函数。
FUNC napi_is_promise 判断给定js value是否为promise对象。
FUNC napi_get_uv_event_loop 获取当前libuv loop实例。
FUNC napi_create_threadsafe_function 创建线程安全函数。
FUNC napi_get_threadsafe_function_context 获取线程安全函数中的context。
FUNC napi_call_threadsafe_function 调用线程安全函数。
FUNC napi_acquire_threadsafe_function 指示线程安全函数可以开始使用。
FUNC napi_release_threadsafe_function 指示线程安全函数将停止使用。
FUNC napi_ref_threadsafe_function 指示在主线程上运行的事件循环在线程安全函数被销毁之前不应退出。
FUNC napi_unref_threadsafe_function 指示在主线程上运行的事件循环可能会在线程安全函数被销毁之前退出。
FUNC napi_create_date 通过一个C的double数据创建js Date。
FUNC napi_get_date_value 获取给定js Date对应的C double值。
FUNC napi_create_bigint_int64 通过一个C的int64数据创建js BigInt。
FUNC napi_create_bigint_uint64 通过一个C的uint64数据创建js BigInt。
FUNC napi_create_bigint_words 通过一个C的uint64数组创建单个js BigInt。
FUNC napi_get_value_bigint_int64 获取给定js BigInt对应的C int64值。
FUNC napi_get_value_bigint_uint64 获取给定js BigInt对应的C uint64值。
FUNC napi_get_value_bigint_words 获取给定js BigInt对应的信息，包括符号位、64位小端序数组和数组中的元素个数。
FUNC napi_create_buffer 创建并获取一个指定大小的js Buffer。
FUNC napi_create_buffer_copy 创建并获取一个指定大小的js Buffer，并以给定数据进行初始化。
FUNC napi_create_external_buffer 创建并获取一个指定大小的js Buffer，并以给定数据进行初始化，该接口可为Buffer附带额外数据。
FUNC napi_get_buffer_info 获取js Buffer底层data及其长度。
FUNC napi_is_buffer 判断给定js value是否为Buffer对象。
FUNC napi_object_freeze 冻结给定的对象。
FUNC napi_object_seal 密封给定的对象。
FUNC napi_get_all_property_names 获取一个数组，其中包含此对象过滤后的属性名称。
FUNC napi_detach_arraybuffer 分离给定ArrayBuffer的底层数据。
FUNC napi_is_detached_arraybuffer 判断给定的ArrayBuffer是否已被分离过。

N-API组件扩展的符号列表

符号类型 符号名 说明
FUNC napi_queue_async_work_with_qos 将异步工作对象加到队列，由底层根据传入的qos优先级去调度执行。
FUNC napi_run_script_path 运行abc文件。