Statically Loading Native Modules

In ECMAScript 6.0 (ES6) module design, the import syntax is used to load content exported by other files, as defined by the ECMAScript specification. To help you import content exported from native modules (.so), ArkTS has adapted and provides the following methods:

Direct Import

Export content from the index.d.ts file of a native module, and then import the content to the file.

[h2]Named Import

// index.d.ts corresponding to libentry.so
export const add: (a: number, b: number) => number;

// NameImport.ets
import { add } from 'libentry.so'
add(2, 3);

[h2]Default Import

// index.d.ts corresponding to libentry.so
export const add: (a: number, b: number) => number;

// DefaultImport.ets
import entry from 'libentry.so'
entry.add(2, 3);

[h2]Namespace Import

// index.d.ts corresponding to libentry.so
export const add: (a: number, b: number) => number;

// NamespaceImport.ets
import * as entry from 'libentry.so'
entry.add(2, 3);

Indirect Import

[h2]Export as Named Variables and Import

// index.d.ts corresponding to libentry.so
export const add: (a: number, b: number) => number;

// NameExport.ets
// Encapsulate the API of libentry.so and export it.
import { add } from 'libentry.so';
export { add };

// NameImportFromExport.ets
// Import APIs from the intermediate module.
import { add } from './NameExport';
const result = add(2, 3);

[h2]Export as Namespaces and Import

// index.d.ts corresponding to libentry.so
export const add: (a: number, b: number) => number;

// NamespaceExport.ets
export * from 'libentry.so'

// NamespaceImportFromExport.ets
import { add } from './NamespaceExport'
add(2, 3);

Native modules do not support both export and import using namespaces simultaneously.

Anti-example:

// test1.ets
export * from 'libentry.so'

// test2.ets
import * as add from './test1'
// The add object cannot be obtained.

Dynamic Import

[h2]Direct Import

// index.d.ts corresponding to libentry.so
export const add: (a: number, b: number) => number;

// DynamicImport.ets
import('libentry.so').then((entry:ESObject) => {
  entry.default.add(2, 3);
})

[h2]Indirect Import

// DynamicExport.ets
import entry from 'libentry.so'
export { entry }

// DynamicImportFromExport.ets
import('./DynamicExport').then((ns:ESObject) => {
  ns.entry.add(2, 3);
})

Dynamic imports do not support exporting files using namespace exports.