package
Tomorrow's ECMAScript modules today!
npm install esmGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
301.3 kB
Includes dependencies.
The brilliantly simple, babel-less, bundle-less ECMAScript module loader.
esmis the world’s most advanced ECMAScript module loader. This fast, production ready, zero dependency loader is all you need to support ECMAScript modules in Node 6+. See the release post and video for details!
New projects
Run npm init esm or yarn create esm.
:bulb: Use the -y flag to answer “yes” to all prompts.
Existing projects
Run npm i esm or yarn add esm.
There are two ways to enable esm.
Enable esm for packages:
Use esm to load the main ES module and export it as CommonJS.
index.js
// Set options as a parameter, environment variable, or rc file.
require = require("esm")(module/*, options*/)
module.exports = require("./main.js")main.js
// ESM syntax is supported.
export {}:bulb: These files are automagically created with npm init esm or yarn create esm.
Enable esm for local runs:
node -r esm main.js:bulb: Omit the filename to enable in the REPL.
:clap: By default, :100: percent CJS interoperability is enabled so you can get stuff done.
:lock: .mjs files are limited to basic functionality without support for esm options.
Out of the box esm just works, no configuration necessary, and supports:
import/exportimport.metaimportSpecify options with one of the following:
"esm" field in package.json.esmrc.js, .esmrc.cjs, or .esmrc.mjs file.esmrc or .esmrc.json fileESM_OPTIONS environment variableESM_DISABLE_CACHE environment variable{ | ||||||||||
"cjs":true | A boolean or object for toggling CJS features in ESM. Features
|
{ | |
"cache":true | A boolean for toggling cache creation or a cache directory path. |
"sourceMap":false | A boolean for including inline source maps. |
} |
For bundlers like browserify+esmify,
parcel-bundler, and webpack
add a "module" field to package.json pointing to the main ES module.
"main": "index.js"
esm for wallaby.js following their
integration example.Load esm before loaders/monitors like
@babel/register,
newrelic,
sqreen, and
ts-node.
esm--check flag (Node 10+)"namedExports":true | A boolean for importing named exports of CJS modules. |
"paths":true | A boolean for following CJS path rules in ESM. |
"vars":true | A boolean for |
"dedefault":false | A boolean for requiring ES modules without the dangling |
"topLevelReturn":false | A boolean for top-level |
} |
"mainFields":["main"] | An array of fields checked when importing a package. |
"mode":"auto" | A string mode:
|
"await":false | A boolean for top-level |
"force":false | A boolean to apply these options to all module loads. |
"wasm":false | A boolean for WebAssembly module support. (Node 8+) |
} |
:bulb: This is automagically done with npm init esm or yarn create esm.
jasminejasmine.json"helpers": [
"node_modules/esm"
]Load esm with “node-args" options of:
pm2: --node-args="-r esm"