# Node API
HBuilderX 5.31+ App平台 蒸汽模式
uni-app x 蒸汽模式，在3个App平台都使用了js引擎，包括Android的V8、iOS的jscore、鸿蒙的arkTS/jsvm。
不同的js引擎，原本的调用方式是不一样的，各自暴露了不同的 C API。但 uni-app x 对外提供了一套统一的 Node API，屏蔽了各js引擎的差异、
它有点类似react native的jsi的作用，但规范更普适（AI更熟悉）、性能更高。
Node API，原本是 Nodejs 面向c语言开发者提供的一套API。鸿蒙系统的 C API 也使用了Node规范。
uni-app x 中，把3个App平台的js引擎操作API，统一封装为 Node API，它为开发者提供了如下价值：
- 成为 uasm插件 的基建，让一个c库，可以同时高性能对接到所有App平台。让一个适配过 Nodejs 的C库可以直接被 uni-app x 使用。
- 开发者可以自主干预c和js的通信，实现更底层的功能
- 在原生工程中，复用v8。 Android的v8体积不小。 原生工程中集成 uni-app x 蒸汽模式的sdk时，如果原本原生工程也有独立使用js引擎的需求，集成2套V8是不合适的。 此时原生工程可以通过 Node API 来使用 uni-app x sdk 中的js引擎，并且能跨平台使用。
# 支持的 Node API清单
uni-app x 中支持的 Node API 并非全集。但覆盖了常见需求，比如在c层获取和写入一个js变量的值，通过napi_run_script执行一段js脚本。
支持的API列表如下，详细说明参考 Node官方文档
HBuilderX 5.31+ 支持的 Node API。接口的参数、返回值和使用示例请参阅 Node.js 官方文档中的详情链接。
提示：暂不支持 worker、thread-safe 等异步API
# napi_get_last_error_info 详情
napi_status napi_get_last_error_info(node_api_basic_env env, const napi_extended_error_info** result);
# napi_get_undefined 详情
napi_status napi_get_undefined(napi_env env, napi_value* result);
# napi_get_null 详情
napi_status napi_get_null(napi_env env, napi_value* result);
# napi_get_global 详情
napi_status napi_get_global(napi_env env, napi_value* result);
# napi_get_boolean 详情
napi_status napi_get_boolean(napi_env env, bool value, napi_value* result);
# napi_create_object 详情
napi_status napi_create_object(napi_env env, napi_value* result);
# napi_create_array 详情
napi_status napi_create_array(napi_env env, napi_value* result);
# napi_create_array_with_length 详情
napi_status napi_create_array_with_length(napi_env env, size_t length, napi_value* result);
# napi_create_arraybuffer 详情
napi_status napi_create_arraybuffer(napi_env env, size_t byte_length, void** data, napi_value* result);
# napi_create_external_arraybuffer 详情
napi_status napi_create_external_arraybuffer(napi_env env, void* external_data, size_t byte_length, node_api_basic_finalize finalize_cb, void* finalize_hint, napi_value* result);
# napi_get_arraybuffer_info 详情
napi_status napi_get_arraybuffer_info(napi_env env, napi_value arraybuffer, void** data, size_t* byte_length);
# napi_is_arraybuffer 详情
napi_status napi_is_arraybuffer(napi_env env, napi_value value, bool* result);
# napi_create_typedarray 详情
napi_status napi_create_typedarray(napi_env env, napi_typedarray_type type, size_t length, napi_value arraybuffer, size_t byte_offset, napi_value* result);
# napi_get_typedarray_info 详情
napi_status napi_get_typedarray_info(napi_env env, napi_value typedarray, napi_typedarray_type* type, size_t* length, void** data, napi_value* arraybuffer, size_t* byte_offset);
# napi_is_typedarray 详情
napi_status napi_is_typedarray(napi_env env, napi_value value, bool* result);
# napi_create_double 详情
napi_status napi_create_double(napi_env env, double value, napi_value* result);
# napi_create_int64 详情
napi_status napi_create_int64(napi_env env, int64_t value, napi_value* result);
# napi_create_bigint_int64 详情
支持版本：Node-API v6 及以上。
napi_status napi_create_bigint_int64(napi_env env, int64_t value, napi_value* result);
# napi_create_string_utf8 详情
napi_status napi_create_string_utf8(napi_env env, const char* str, size_t length, napi_value* result);
# napi_create_function 详情
napi_status napi_create_function(napi_env env, const char* utf8name, size_t length, napi_callback cb, void* data, napi_value* result);
# napi_typeof 详情
napi_status napi_typeof(napi_env env, napi_value value, napi_valuetype* result);
# napi_get_value_bool 详情
napi_status napi_get_value_bool(napi_env env, napi_value value, bool* result);
# napi_get_value_double 详情
napi_status napi_get_value_double(napi_env env, napi_value value, double* result);
# napi_get_value_int32 详情
napi_status napi_get_value_int32(napi_env env, napi_value value, int32_t* result);
# napi_get_value_uint32 详情
napi_status napi_get_value_uint32(napi_env env, napi_value value, uint32_t* result);
# napi_get_value_int64 详情
napi_status napi_get_value_int64(napi_env env, napi_value value, int64_t* result);
# napi_get_value_bigint_int64 详情
支持版本：Node-API v6 及以上。
napi_status napi_get_value_bigint_int64(napi_env env, napi_value value, int64_t* result, bool* lossless);
# napi_get_value_bigint_uint64 详情
支持版本：Node-API v6 及以上。
napi_status napi_get_value_bigint_uint64(napi_env env, napi_value value, uint64_t* result, bool* lossless);
# napi_get_value_string_utf8 详情
napi_status napi_get_value_string_utf8(napi_env env, napi_value value, char* buf, size_t bufsize, size_t* result);
# napi_get_cb_info 详情
napi_status napi_get_cb_info(napi_env env, napi_callback_info info, size_t* argc, napi_value* argv, napi_value* this_arg, void** data);
# napi_get_new_target 详情
napi_status napi_get_new_target(napi_env env, napi_callback_info info, napi_value* result);
# napi_call_function 详情
napi_status napi_call_function(napi_env env, napi_value recv, napi_value func, size_t argc, const napi_value* argv, napi_value* result);
# napi_new_instance 详情
napi_status napi_new_instance(napi_env env, napi_value constructor, size_t argc, const napi_value* argv, napi_value* result);
# napi_get_property 详情
napi_status napi_get_property(napi_env env, napi_value object, napi_value key, napi_value* result);
# napi_has_property 详情
napi_status napi_has_property(napi_env env, napi_value object, napi_value key, bool* result);
# napi_has_own_property 详情
napi_status napi_has_own_property(napi_env env, napi_value object, napi_value key, bool* result);
# napi_get_property_names 详情
napi_status napi_get_property_names(napi_env env, napi_value object, napi_value* result);
# napi_has_named_property 详情
napi_status napi_has_named_property(napi_env env, napi_value object, const char* utf8name, bool* result);
# napi_get_named_property 详情
napi_status napi_get_named_property(napi_env env, napi_value object, const char* utf8name, napi_value* result);
# napi_set_named_property 详情
napi_status napi_set_named_property(napi_env env, napi_value object, const char* utf8name, napi_value value);
# napi_get_element 详情
napi_status napi_get_element(napi_env env, napi_value object, uint32_t index, napi_value* result);
# napi_set_element 详情
napi_status napi_set_element(napi_env env, napi_value object, uint32_t index, napi_value value);
# napi_is_array 详情
napi_status napi_is_array(napi_env env, napi_value value, bool* result);
# napi_get_array_length 详情
napi_status napi_get_array_length(napi_env env, napi_value value, uint32_t* result);
# napi_define_properties 详情
napi_status napi_define_properties(napi_env env, napi_value object, size_t property_count, const napi_property_descriptor* properties);
# napi_define_class 详情
napi_status napi_define_class(napi_env env, const char* utf8name, size_t length, napi_callback constructor, void* data, size_t property_count, const napi_property_descriptor* properties, napi_value* result);
# napi_wrap 详情
napi_status napi_wrap(napi_env env, napi_value js_object, void* native_object, node_api_basic_finalize finalize_cb, void* finalize_hint, napi_ref* result);
# napi_unwrap 详情
napi_status napi_unwrap(napi_env env, napi_value js_object, void** result);
# napi_remove_wrap 详情
napi_status napi_remove_wrap(napi_env env, napi_value js_object, void** result);
# napi_create_external 详情
napi_status napi_create_external(napi_env env, void* data, node_api_basic_finalize finalize_cb, void* finalize_hint, napi_value* result);
# napi_get_value_external 详情
napi_status napi_get_value_external(napi_env env, napi_value value, void** result);
# napi_add_finalizer 详情
napi_status napi_add_finalizer(napi_env env, napi_value js_object, void* finalize_data, node_api_basic_finalize finalize_cb, void* finalize_hint, napi_ref* result);
# napi_create_reference 详情
napi_status napi_create_reference(napi_env env, napi_value value, uint32_t initial_refcount, napi_ref* result);
# napi_delete_reference 详情
napi_status napi_delete_reference(node_api_basic_env env, napi_ref ref);
# napi_get_reference_value 详情
napi_status napi_get_reference_value(napi_env env, napi_ref ref, napi_value* result);
# napi_reference_ref 详情
napi_status napi_reference_ref(napi_env env, napi_ref ref, uint32_t* result);
# napi_reference_unref 详情
napi_status napi_reference_unref(napi_env env, napi_ref ref, uint32_t* result);
# napi_create_promise 详情
napi_status napi_create_promise(napi_env env, napi_deferred* deferred, napi_value* promise);
# napi_resolve_deferred 详情
napi_status napi_resolve_deferred(napi_env env, napi_deferred deferred, napi_value resolution);
# napi_reject_deferred 详情
napi_status napi_reject_deferred(napi_env env, napi_deferred deferred, napi_value rejection);
# napi_open_handle_scope 详情
napi_status napi_open_handle_scope(napi_env env, napi_handle_scope* result);
# napi_close_handle_scope 详情
napi_status napi_close_handle_scope(napi_env env, napi_handle_scope scope);
# napi_open_escapable_handle_scope 详情
napi_status napi_open_escapable_handle_scope(napi_env env, napi_escapable_handle_scope* result);
# napi_close_escapable_handle_scope 详情
napi_status napi_close_escapable_handle_scope(napi_env env, napi_escapable_handle_scope scope);
# napi_escape_handle 详情
napi_status napi_escape_handle(napi_env env, napi_escapable_handle_scope scope, napi_value escapee, napi_value* result);
# napi_is_dataview 详情
napi_status napi_is_dataview(napi_env env, napi_value value, bool* result);
# napi_get_dataview_info 详情
napi_status napi_get_dataview_info(napi_env env, napi_value dataview, size_t* bytelength, void** data, napi_value* arraybuffer, size_t* byte_offset);
# napi_set_instance_data 详情
支持版本：Node-API v6 及以上。
napi_status napi_set_instance_data(node_api_basic_env env, void* data, napi_finalize finalize_cb, void* finalize_hint);
# napi_get_instance_data 详情
支持版本：Node-API v6 及以上。
napi_status napi_get_instance_data(node_api_basic_env env, void** data);
# napi_throw_error 详情
napi_status napi_throw_error(napi_env env, const char* code, const char* msg);
# napi_throw_type_error 详情
napi_status napi_throw_type_error(napi_env env, const char* code, const char* msg);
# napi_throw_range_error 详情
napi_status napi_throw_range_error(napi_env env, const char* code, const char* msg);
# napi_create_error 详情
napi_status napi_create_error(napi_env env, napi_value code, napi_value msg, napi_value* result);
# napi_create_type_error 详情
napi_status napi_create_type_error(napi_env env, napi_value code, napi_value msg, napi_value* result);
# napi_create_range_error 详情
napi_status napi_create_range_error(napi_env env, napi_value code, napi_value msg, napi_value* result);
# napi_throw 详情
napi_status napi_throw(napi_env env, napi_value error);
# napi_is_error 详情
napi_status napi_is_error(napi_env env, napi_value value, bool* result);
# napi_is_exception_pending 详情
napi_status napi_is_exception_pending(napi_env env, bool* result);
# napi_get_and_clear_last_exception 详情
napi_status napi_get_and_clear_last_exception(napi_env env, napi_value* result);
# napi_create_int32 详情
napi_status napi_create_int32(napi_env env, int32_t value, napi_value* result);
# napi_create_uint32 详情
napi_status napi_create_uint32(napi_env env, uint32_t value, napi_value* result);
# napi_create_string_latin1 详情
napi_status napi_create_string_latin1(napi_env env, const char* str, size_t length, napi_value* result);
# napi_create_string_utf16 详情
napi_status napi_create_string_utf16(napi_env env, const char16_t* str, size_t length, napi_value* result);
# napi_create_symbol 详情
napi_status napi_create_symbol(napi_env env, napi_value description, napi_value* result);
# napi_get_value_string_latin1 详情
napi_status napi_get_value_string_latin1(napi_env env, napi_value value, char* buf, size_t bufsize, size_t* result);
# napi_get_value_string_utf16 详情
napi_status napi_get_value_string_utf16(napi_env env, napi_value value, char16_t* buf, size_t bufsize, size_t* result);
# napi_coerce_to_bool 详情
napi_status napi_coerce_to_bool(napi_env env, napi_value value, napi_value* result);
# napi_coerce_to_number 详情
napi_status napi_coerce_to_number(napi_env env, napi_value value, napi_value* result);
# napi_coerce_to_object 详情
napi_status napi_coerce_to_object(napi_env env, napi_value value, napi_value* result);
# napi_coerce_to_string 详情
napi_status napi_coerce_to_string(napi_env env, napi_value value, napi_value* result);
# napi_get_prototype 详情
napi_status napi_get_prototype(napi_env env, napi_value object, napi_value* result);
# napi_set_property 详情
napi_status napi_set_property(napi_env env, napi_value object, napi_value key, napi_value value);
# napi_delete_property 详情
napi_status napi_delete_property(napi_env env, napi_value object, napi_value key, bool* result);
# napi_has_element 详情
napi_status napi_has_element(napi_env env, napi_value object, uint32_t index, bool* result);
# napi_delete_element 详情
napi_status napi_delete_element(napi_env env, napi_value object, uint32_t index, bool* result);
# napi_strict_equals 详情
napi_status napi_strict_equals(napi_env env, napi_value lhs, napi_value rhs, bool* result);
# napi_instanceof 详情
napi_status napi_instanceof(napi_env env, napi_value object, napi_value constructor, bool* result);
# napi_create_dataview 详情
napi_status napi_create_dataview(napi_env env, size_t length, napi_value arraybuffer, size_t byte_offset, napi_value* result);
# napi_get_version 详情
napi_status napi_get_version(node_api_basic_env env, uint32_t* result);
# napi_is_promise 详情
napi_status napi_is_promise(napi_env env, napi_value value, bool* is_promise);
# napi_run_script 详情
napi_status napi_run_script(napi_env env, napi_value script, napi_value* result);
# napi_adjust_external_memory 详情
napi_status napi_adjust_external_memory(node_api_basic_env env, int64_t change_in_bytes, int64_t* adjusted_value);
# napi_create_date 详情
支持版本：Node-API v5 及以上。
napi_status napi_create_date(napi_env env, double time, napi_value* result);
# napi_is_date 详情
支持版本：Node-API v5 及以上。
napi_status napi_is_date(napi_env env, napi_value value, bool* is_date);
# napi_get_date_value 详情
支持版本：Node-API v5 及以上。
napi_status napi_get_date_value(napi_env env, napi_value value, double* result);
# napi_create_bigint_uint64 详情
支持版本：Node-API v6 及以上。
napi_status napi_create_bigint_uint64(napi_env env, uint64_t value, napi_value* result);
# napi_create_bigint_words 详情
支持版本：Node-API v6 及以上。
napi_status napi_create_bigint_words(napi_env env, int sign_bit, size_t word_count, const uint64_t* words, napi_value* result);
# napi_get_value_bigint_words 详情
支持版本：Node-API v6 及以上。
napi_status napi_get_value_bigint_words(napi_env env, napi_value value, int* sign_bit, size_t* word_count, uint64_t* words);
# napi_get_all_property_names 详情
支持版本：Node-API v6 及以上。
napi_status napi_get_all_property_names(napi_env env, napi_value object, napi_key_collection_mode key_mode, napi_key_filter key_filter, napi_key_conversion key_conversion, napi_value* result);
# napi_detach_arraybuffer 详情
支持版本：Node-API v7 及以上。
napi_status napi_detach_arraybuffer(napi_env env, napi_value arraybuffer);
# napi_is_detached_arraybuffer 详情
支持版本：Node-API v7 及以上。
napi_status napi_is_detached_arraybuffer(napi_env env, napi_value value, bool* result);
# napi_type_tag_object 详情
支持版本：Node-API v8 及以上。
napi_status napi_type_tag_object(napi_env env, napi_value value, const napi_type_tag* type_tag);
# napi_check_object_type_tag 详情
支持版本：Node-API v8 及以上。
napi_status napi_check_object_type_tag(napi_env env, napi_value value, const napi_type_tag* type_tag, bool* result);
# napi_object_freeze 详情
支持版本：Node-API v8 及以上。
napi_status napi_object_freeze(napi_env env, napi_value object);
# napi_object_seal 详情
支持版本：Node-API v8 及以上。
napi_status napi_object_seal(napi_env env, napi_value object);
本页导读
