Currently an alpha-quality, best-effort implementation.
May be unnecessary if you use TypeScript's"module": "NodeNext", "moduleResolution": "NodeNext"
Node.js allows dynamic import()
calls within CommonJS file. TypeScript transforms import()
into require()
when targetting CommonJS.
This presents a problem when a .ts
file compiled to CommonJS wants to do a truly async, dynamic import of a native ESM module. How do we
avoid TypeScript's transformation from import()
to require()
?
This library implements a workaround. Replace import('lib')
with dynamicImport('lib', module)
.
import {dynamicImport} from 'tsimportlib';
async function main() {
const dynamicallyImportedEsmModule = await dynamicImport('truly-esm-module', module) as typeof import('truly-esm-module');
}
async function loadPlugin(name: string) {
// In this example, plugins may or may not be native ESM, so we use dynamic import to support both.
const dynamicallyImportedPlugin = await dynamicImport(name, module) as MyPluginInterface;
}
Due to Node.js limitations, we must use the CommonJS resolver to locate modules. This should work well enough for third-party modules, but may not work for dual-mode modules or ones that suppress importing of their package.json file. As a fallback you can pass an absolute path to the target module.