Node-API支持的Node-API接口(一)

一、异步安全线程相关

接口功能说明
napi_create_threadsafe_function创建线程安全函数。
napi_get_threadsafe_function_context获取线程安全函数中的context。
napi_call_threadsafe_function调用线程安全函数。
napi_acquire_threadsafe_function指示线程安全函数可以开始使用。
napi_release_threadsafe_function指示线程安全函数将停止使用。
napi_ref_threadsafe_function指示在主线程上运行的事件循环在线程安全函数被销毁之前不应退出。
napi_unref_threadsafe_function指示在主线程上运行的事件循环可能会在线程安全函数被销毁之前退出。

二、buffer相关 

接口功能说明
napi_create_buffer创建并获取一个指定大小的JS Buffer。
napi_create_buffer_copy创建并获取一个指定大小的JS Buffer,并以给定数据进行初始化。
napi_create_external_buffer创建并获取一个指定大小的JS Buffer,并以给定数据进行初始化,该接口可为Buffer附带额外数据。
napi_get_buffer_info获取JS Buffer底层data及其长度。
napi_is_buffer判断给定JS value是否为Buffer对象。
napi_create_external_arraybuffer分配一个附加有外部数据的JS ArrayBuffer。

三、string相关

接口功能说明
napi_create_string_utf16通过UTF16编码的C字符串数据创建JS String。
napi_get_value_string_utf16获取给定JS vaule对应的UTF16编码的字符串。
napi_create_string_latin1通过ISO-8859-1编码的C字符串数据创建JS String。
napi_create_string_utf8通过UTF8编码的C字符串数据创建JS String。
napi_get_value_string_latin1获取给定JS vaule对应的ISO-8859-1编码的字符串。
napi_get_value_string_utf8获取给定JS vaule对应的UTF8编码的字符串。

 四、date相关

接口功能说明
napi_create_date通过一个C的double数据创建JS Date。
napi_get_date_value获取给定JS Date对应的C double值。
napi_is_date判断给定JS value是否为JS Date对象。

五、arraybuffer相关

接口功能说明
napi_get_arraybuffer_info获取ArrayBuffer的底层data buffer及其长度。
napi_is_arraybuffer判断给定JS value是否为ArrayBuffer。
napi_detach_arraybuffer分离给定ArrayBuffer的底层数据。
napi_is_detached_arraybuffer判断给定的ArrayBuffer是否已被分离。
napi_create_arraybuffer创建并获取一个指定大小的JS ArrayBuffer。

六、module相关

接口功能说明
napi_module_registernative模块注册接口。

七、生命周期相关

接口功能说明
napi_open_handle_scope创建一个上下文环境使用。需要使用napi_close_handle_scope进行关闭。
napi_close_handle_scope关闭传入的上下文环境,关闭后,全部在其中声明的引用都将被关闭。
napi_open_escapable_handle_scope创建出一个可逃逸的handle scope,可将范围内声明的值返回到父作用域。需要使用napi_close_escapable_handle_scope进行关闭。
napi_close_escapable_handle_scope关闭传入的可逃逸的handle scope。
napi_escape_handle提升传入的JS Object的生命周期到其父作用域。
napi_create_reference为Object创建一个reference,以延长其生命周期。调用者需要自己管理reference生命周期。
napi_delete_reference删除传入的reference。
napi_reference_ref增加传入的reference的引用计数,并获取新的计数。
napi_reference_unref减少传入的reference的引用计数,并获取新的计数。
napi_get_reference_value获取与reference相关联的JS Object。
napi_add_finalizer当js Object中的对象被垃圾回收时调用注册的napi_finalize回调。

八、promise相关

接口功能说明
napi_create_promise创建一个promise对象。
napi_resolve_deferred对promise关联的deferred对象进行resolve。
napi_reject_deferred对promise关联的deferred对象进行reject。
napi_is_promise判断给定napi_value是否为promise对象。

九、array相关

接口功能说明
napi_create_array创建并获取一个JS Array。
napi_create_array_with_length创建并获取一个指定长度的JS Array。
napi_create_typedarray通过现有的ArrayBuffer创建一个JS TypeArray。
napi_create_dataview通过现有的ArrayBuffer创建一个JS DataView。
napi_get_array_length获取array的length。
napi_get_typedarray_info获取给定TypedArray的各种属性。
napi_get_dataview_info获取给定DataView的各种属性。
napi_is_array判断给定JS value是否为array。
napi_set_element在给定Object的指定索引处,设置元素。
napi_get_element获取给定Object指定索引处的元素。
napi_has_element若给定Object的指定索引处拥有属性,获取该元素。
napi_delete_element尝试删除给定Object的指定索引处的元素。

十、primitive相关

接口功能说明
napi_get_boolean根据给定的C boolean值,获取JS Boolean对象。
napi_get_global获取global对象。
napi_get_null获取null对象。
napi_get_undefined获取undefined对象。
napi_coerce_to_bool将给定的JS value强转成JS Boolean。
napi_coerce_to_number将给定的JS value强转成JS Number。
napi_coerce_to_object将给定的JS value强转成JS Object。
napi_coerce_to_string将给定的JS value强转成JS String。

十一、class相关

接口功能说明
napi_get_new_target获取构造函数调用的new.target。
napi_define_class定义与C++类相对应的JavaScript类。
napi_new_instance通过给定的构造函数,构建一个实例。

十二、object相关

接口功能说明
napi_get_prototype获取给定JS Object的prototype。
napi_create_object创建一个默认的JS Object。
napi_object_freeze冻结给定的对象。
napi_object_seal密封给定的对象。
napi_typeof获取给定JS value的JS Type。
napi_instanceof判断给定object是否为给定constructor的实例。
napi_type_tag_object将tag指针的值与Object关联。
napi_check_object_type_tag判断给定的tag指针是否被关联到了JS Object上。

十三、bigint相关

接口功能说明
napi_create_bigint_int64通过一个C的int64数据创建JS BigInt。
napi_create_bigint_uint64通过一个C的uint64数据创建JS BigInt。
napi_create_bigint_words通过一个C的uint64数组创建单个JS BigInt。
napi_get_value_bigint_int64获取给定JS BigInt对应的C int64值。
napi_get_value_bigint_uint64获取给定JS BigInt对应的C uint64值。
napi_get_value_bigint_words获取给定JS BigInt对应的信息,包括符号位、64位小端序数组和数组中的元素个数。

十四、异常和错误相关

接口功能说明
napi_throw抛出一个JS value。
napi_throw_type_error抛出一个带文本信息的JS TypeError。
napi_throw_range_error抛出一个带文本信息的JS RangeError。
napi_is_error判断napi_value是否表示为一个error对象。
napi_create_error创建并获取一个带文本信息的JS Error。
napi_create_type_error创建并获取一个带文本信息的JS TypeError。
napi_create_range_error创建并获取一个带文本信息的JS RangeError。
napi_get_and_clear_last_exception获取并清除最近一次出现的异常。
napi_is_exception_pending判断是否出现了异常。
napi_fatal_error引发致命错误以立即终止进程。
napi_get_last_error_info获取napi_extended_error_info结构体,其中包含最近一次出现的error信息。
napi_fatal_exception抛出一个致命异常并终止进程, 同时产生相应的crash日志。

十五、属性相关

接口功能说明
napi_get_property_names以字符串数组的形式获取对象的可枚举属性的名称。
napi_set_property对给定Object设置属性。
napi_get_property获取给定Object的给定属性。
napi_has_property判断给定对象中是否存在给定属性。
napi_delete_property尝试从给定Object中删除给定key属性。
napi_has_own_property判断给定Object中是否有名为key的own property。
napi_set_named_property对给定Object设置一个给定名称的属性。
napi_get_named_property获取给定Object中指定名称的属性。
napi_has_named_property判断给定Object中是否有给定名称的属性。
napi_define_properties批量的向给定Object中定义属性。
napi_get_all_property_names获取一个数组,其中包含此对象过滤后的属性名称。

十六、异步任务相关

接口功能说明
napi_create_async_work创建一个异步工作对象。
napi_delete_async_work释放先前创建的异步工作对象。
napi_queue_async_work将异步工作对象加到队列,由底层去调度执行。
napi_cancel_async_work取消入队的异步任务。

十七、自定义异步操作

接口功能说明
napi_async_init创建一个异步资源上下文环境(不支持与async_hook相关能力)。
napi_make_callback在异步资源上下文环境中回调JS函数(不支持与async_hook相关能力)。
napi_async_destroy销毁先前创建的异步资源上下文环境(不支持与async_hook相关能力)。
napi_open_callback_scope创建一个回调作用域(不支持与async_hook相关能力)。
napi_close_callback_scope关闭先前创建的回调作用域(不支持与async_hook相关能力)。

十八、判断给定的两个JS value是否严格相等

接口功能说明
napi_strict_equals判断给定的两个JS value是否严格相等。

十九、uv相关

接口功能说明
napi_get_uv_event_loop获取当前libuv loop实例。

二十、函数调用

接口功能说明
napi_call_function在C/C++侧调用JS方法。
napi_get_cb_info从给定的callback info中获取有关调用的详细信息,如参数和this指针。

 

  • 13
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值