You can use napi_load_module to load a module in the main thread. After the module is loaded, you can use napi_get_property to obtain the variables of the module or use napi_get_named_property to obtain the functions of the module.
napi_status napi_load_module(napi_env env, const char* path, napi_value* result);
| Parameter | Description |
|---|---|
| env | Current JSVM environment. |
| path | Pointer to the path of the file or name of the module to load. |
| result | Pointer to the module loaded. |
You are advised to use napi_load_module_with_info to load modules. This API supports more scenarios.
| Scenario | Scenario Description | Remarks |
|---|---|---|
| System module | Load @ohos. or @system.. | - |
| Local project module | Load a module defined in a file under the ets directory. | The file path must start with ets. |
| Local project module | Load a file path in a module. | The file path must start with moduleName. |
| Local project module | Load the name of a HAR module. | - |
| Local project module | Load the name of an HSP module. | - |
| Remote package | Load the name of a remote HAR module. | - |
| Remote package | Load the ohpm package name. | - |
| Module Native Library | Loads a native module (.so file) | - |
Loading a System Module
static napi_value loadModule(napi_env env, napi_callback_info info)
{
// 1. Use napi_load_module to load the @ohos.hilog module.
napi_value result;
napi_status status = napi_load_module(env, "@ohos.hilog", &result);
if (status != napi_ok) {
return nullptr;
}
// 2. Use napi_get_named_property to obtain the info function.
napi_value infoFn;
status = napi_get_named_property(env, result, "info", &infoFn);
if (status != napi_ok) {
return nullptr;
}
napi_value tag;
std::string formatStr = "test";
napi_create_string_utf8(env, formatStr.c_str(), formatStr.size(), &tag);
napi_value outputString;
std::string str = "Hello HarmonyOS";
napi_create_string_utf8(env, str.c_str(), str.size(), &outputString);
napi_value flag;
napi_create_int32(env, 0, &flag);
napi_value args[3] = {flag, tag, outputString};
// 3. Use napi_call_function to call the info function.
status = napi_call_function(env, result, infoFn, 3, args, nullptr);
if (status != napi_ok) {
return nullptr;
}
return result;
} Loading a Module Defined in a File Under the ets Directory
For example, load a module from a file as shown in the following ArkTS code:
let value = 123;
function test() {
console.info('Hello HarmonyOS');
}
export {value, test}; Add the following to the build-profile.json5 file of the module.
"buildOption": {
"arkOptions" : {
"runtimeOnly" : {
"sources": [
"./src/main/ets/Test.ets"
],
"packages": [
"library",
"sharedlibrary",
"@ohos/hypium",
"@ohos/axios",
"libentry7.so"
]
}
},
// ...
}, Call napi_load_module to load the module from the Test.ets file, call the test() function, and obtain the value variable.
static napi_value loadModule(napi_env env, napi_callback_info info)
{
napi_value result;
// 1. Use napi_load_module to load the module in the Test file.
napi_status status = napi_load_module(env, "ets/Test", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value testFn;
// 2. Use napi_get_named_property to obtain the test function.
status = napi_get_named_property(env, result, "test", &testFn);
if (status != napi_ok) {
return nullptr;
}
// 3. Use napi_call_function to call the test function.
status = napi_call_function(env, result, testFn, 0, nullptr, nullptr);
if (status != napi_ok) {
return nullptr;
}
napi_value value;
napi_value key;
std::string keyStr = "value";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 4. Use napi_get_property to obtain the value variable.
status = napi_get_property(env, result, key, &value);
if (status != napi_ok) {
return nullptr;
}
return result;
} Loading a File Path in a Module
For example, load a module from a file as shown in the following ArkTS code:
//./src/main/ets/Test.ets
let value = 123;
function test() {
console.info("Hello HarmonyOS");
}
export {value, test}; Configure the build-profile.json5 file of the current module as follows:
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"sources": [
"./src/main/ets/Test.ets"
]
}
}
}
} Call napi_load_module to load the module from the Test.ets file, call the test() function, and obtain the value variable.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load the module from the Test.ets file.
napi_status status = napi_load_module(env, "entry/src/main/ets/Test", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value testFn;
// 2. Call napi_get_named_property to obtain the test function.
status = napi_get_named_property(env, result, "test", &testFn);
if (status != napi_ok) {
return nullptr;
}
// 3. Call napi_call_function to invoke the test function.
status = napi_call_function(env, result, testFn, 0, nullptr, nullptr);
if (status != napi_ok) {
return nullptr;
}
napi_value value;
napi_value key;
std::string keyStr = "value";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 4. Call napi_get_property to obtain the value variable.
status = napi_get_property(env, result, key, &value);
if (status != napi_ok) {
return nullptr;
}
return result;
} Loading a HAR Module
For example, the Index.ets file in a HAR is as follows:
// Library Index.ets
let value = 123;
function test() {
console.info("Hello HarmonyOS");
}
export {value, test}; Configure dependencies in the oh-package.json5 file of the module.
{
"dependencies": {
"library": "file:../library"
}
} Configure build-profile.json5 for the module that uses the library.
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"packages": [
"library"
]
}
}
}
} Call napi_load_module to load the library, call the test function, and obtain the value variable.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load the library.
napi_status status = napi_load_module(env, "library", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value testFn;
// 2. Call napi_get_named_property to obtain the test function.
status = napi_get_named_property(env, result, "test", &testFn);
if (status != napi_ok) {
return nullptr;
}
// 3. Call napi_call_function to invoke the test function.
status = napi_call_function(env, result, testFn, 0, nullptr, nullptr);
if (status != napi_ok) {
return nullptr;
}
napi_value value;
napi_value key;
std::string keyStr = "value";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 4. Call napi_get_property to obtain the value variable.
status = napi_get_property(env, result, key, &value);
if (status != napi_ok) {
return nullptr;
}
return result;
} Loading an HSP module
For example, the Index.ets file in an HSP is as follows:
// Shared library Index.ets
let value = 123;
function test() {
console.info("Hello HarmonyOS");
}
export {value, test}; Configure dependencies in the oh-package.json5 file of the module.
{
"dependencies": {
"sharedlibrary": "file:../sharedlibrary"
}
} Configure build-profile.json5 for the module that uses sharedlibrary.
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"packages": [
"sharedlibrary"
]
}
}
}
} Call napi_load_module to load the shared library, call the test function, and obtain the value variable.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load the shared library.
napi_status status = napi_load_module(env, "sharedlibrary", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value testFn;
// 2. Call napi_get_named_property to obtain the test function.
status = napi_get_named_property(env, result, "test", &testFn);
if (status != napi_ok) {
return nullptr;
}
// 3. Call napi_call_function to invoke the test function.
status = napi_call_function(env, result, testFn, 0, nullptr, nullptr);
if (status != napi_ok) {
return nullptr;
}
napi_value value;
napi_value key;
std::string keyStr = "value";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 4. Call napi_get_property to obtain the value variable.
status = napi_get_property(env, result, key, &value);
if (status != napi_ok) {
return nullptr;
}
return result;
} Configure dependencies in the oh-package.json5 file of the module.
{
"dependencies": {
"@ohos/hypium": "1.0.16"
}
} Configure build-profile.json5 for the module that uses @ohos/hypium.
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"packages": [
"@ohos/hypium"
]
}
}
}
} Call napi_load_module to load @ohos/hypium and obtain the DEFAULT variable.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load @ohos/hypium.
napi_status status = napi_load_module(env, "@ohos/hypium", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value key;
std::string keyStr = "DEFAULT";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 2. Call napi_get_property to obtain the DEFAULT variable.
napi_value defaultValue;
status = napi_get_property(env, result, key, &defaultValue);
if (status != napi_ok) {
return nullptr;
}
return result;
} Configure dependencies in the oh-package.json5 file of the module.
{
"dependencies": {
"@ohos/axios": "2.2.4",
}
} Configure build-profile.json5 for the module that uses @ohos/axios.
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"packages": [
"@ohos/axios"
]
}
}
}
} Call napi_load_module to load @ohos/axios and obtain the VERSION variable.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load @ohos/axios.
napi_status status = napi_load_module(env, "@ohos/axios", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value key;
std::string keyStr = "VERSION";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 2. Call napi_get_property to obtain the version.
napi_value defaultValue;
status = napi_get_property(env, result, key, &defaultValue);
if (status != napi_ok) {
return nullptr;
}
return result;
} Loading a Native Library
For example, the index.d.ts file of libentry.so is as follows:
//index.d.ts export const add: (a: number, b: number) => number;
Configure dependencies in the oh-package.json5 file of the module.
{
"dependencies": {
"libentry.so": "file:../src/main/cpp/types/libentry"
}
} Configure build-profile.json5 for the module that uses libentry.so.
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"packages": [
"libentry.so"
]
}
}
}
} Call napi_load_module to load libentry.so and call the add function.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load libentry.so.
napi_status status = napi_load_module(env, "libentry.so", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value addFn;
// 2. Call napi_get_named_property to obtain the add() function.
status = napi_get_named_property(env, result, "add", &addFn);
if (status != napi_ok) {
return nullptr;
}
napi_value a;
napi_value b;
napi_create_int32(env, 2, &a);
napi_create_int32(env, 3, &b);
napi_value args[2] = {a, b};
// 3. Call napi_call_function to invoke the add() function.
napi_value returnValue;
status = napi_call_function(env, result, addFn, 2, args, &returnValue);
if (status != napi_ok) {
return nullptr;
}
return result;
} Loading Another HAR Module to a HAR
For example, load har2 to har1. The Index.ets file of har2 is as follows:
//har2 Index.ets
let value = 123;
function test() {
console.info("Hello HarmonyOS");
}
export {value, test}; Configure dependencies in the oh-package.json5 file of har1.
{
"dependencies": {
"har2": "file:../har2"
}
} Configure the build-profile.json5 file for har1.
{
"buildOption" : {
"arkOptions" : {
"runtimeOnly" : {
"packages": [
"har2"
]
}
}
}
} Call napi_load_module to load har2 to har1, call the test function, and obtain the value variable.
static napi_value loadModule(napi_env env, napi_callback_info info) {
napi_value result;
// 1. Call napi_load_module to load har2.
napi_status status = napi_load_module(env, "har2", &result);
if (status != napi_ok) {
return nullptr;
}
napi_value testFn;
// 2. Call napi_get_named_property to obtain the test function.
status = napi_get_named_property(env, result, "test", &testFn);
if (status != napi_ok) {
return nullptr;
}
// 3. Call napi_call_function to invoke the test function.
status = napi_call_function(env, result, testFn, 0, nullptr, nullptr);
if (status != napi_ok) {
return nullptr;
}
napi_value value;
napi_value key;
std::string keyStr = "value";
napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);
// 4. Call napi_get_property to obtain the value variable.
status = napi_get_property(env, result, key, &value);
if (status != napi_ok) {
return nullptr;
}
return result;
}