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.

Named Import

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

Index.d.ts

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

NameImport.ets

Default Import

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

Index.d.ts

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

DefaultImport.ets

Namespace Import

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

Index.d.ts

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

NamespaceImport.ets

Indirect Import

Export as Named Variables and Import

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

Index.d.ts

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

NameExport.ets

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

NameImportFromExport.ets

Export as Namespaces and Import

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

Index.d.ts

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

NamespaceExport.ets

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

NamespaceImportFromExport.ets

NOTE

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

Direct Import

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

Index.d.ts

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

DynamicImport.ets

Indirect Import

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

DynamicExport.ets

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

DynamicImportFromExport.ets

NOTE

Dynamic imports do not support exporting files using namespace exports.

Anti-example:

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

// test2.ets
import('./test1').then((ns:ESObject) => {
    // The ns object cannot be obtained.
})