Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/home/real/node-v13.0.1/doc/api/ |
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>ECMAScript Modules | Node.js v13.0.1 Documentation</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
<link rel="stylesheet" href="assets/style.css">
<link rel="stylesheet" href="assets/sh.css">
<link rel="canonical" href="https://nodejs.org/api/esm.html">
</head>
<body class="alt apidoc" id="api-section-esm">
<div id="content" class="clearfix">
<div id="column2" class="interior">
<div id="intro" class="interior">
<a href="/" title="Go back to the home page">
Node.js
</a>
</div>
<ul>
<li><a href="documentation.html" class="nav-documentation">About these Docs</a></li>
<li><a href="synopsis.html" class="nav-synopsis">Usage & Example</a></li>
</ul>
<div class="line"></div>
<ul>
<li><a href="assert.html" class="nav-assert">Assertion Testing</a></li>
<li><a href="async_hooks.html" class="nav-async_hooks">Async Hooks</a></li>
<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
<li><a href="addons.html" class="nav-addons">C++ Addons</a></li>
<li><a href="n-api.html" class="nav-n-api">C/C++ Addons - N-API</a></li>
<li><a href="child_process.html" class="nav-child_process">Child Processes</a></li>
<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
<li><a href="cli.html" class="nav-cli">Command Line Options</a></li>
<li><a href="console.html" class="nav-console">Console</a></li>
<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
<li><a href="dns.html" class="nav-dns">DNS</a></li>
<li><a href="domain.html" class="nav-domain">Domain</a></li>
<li><a href="esm.html" class="nav-esm active">ECMAScript Modules</a></li>
<li><a href="errors.html" class="nav-errors">Errors</a></li>
<li><a href="events.html" class="nav-events">Events</a></li>
<li><a href="fs.html" class="nav-fs">File System</a></li>
<li><a href="globals.html" class="nav-globals">Globals</a></li>
<li><a href="http.html" class="nav-http">HTTP</a></li>
<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
<li><a href="https.html" class="nav-https">HTTPS</a></li>
<li><a href="inspector.html" class="nav-inspector">Inspector</a></li>
<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
<li><a href="modules.html" class="nav-modules">Modules</a></li>
<li><a href="net.html" class="nav-net">Net</a></li>
<li><a href="os.html" class="nav-os">OS</a></li>
<li><a href="path.html" class="nav-path">Path</a></li>
<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance Hooks</a></li>
<li><a href="policy.html" class="nav-policy">Policies</a></li>
<li><a href="process.html" class="nav-process">Process</a></li>
<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
<li><a href="querystring.html" class="nav-querystring">Query Strings</a></li>
<li><a href="readline.html" class="nav-readline">Readline</a></li>
<li><a href="repl.html" class="nav-repl">REPL</a></li>
<li><a href="report.html" class="nav-report">Report</a></li>
<li><a href="stream.html" class="nav-stream">Stream</a></li>
<li><a href="string_decoder.html" class="nav-string_decoder">String Decoder</a></li>
<li><a href="timers.html" class="nav-timers">Timers</a></li>
<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
<li><a href="tracing.html" class="nav-tracing">Trace Events</a></li>
<li><a href="tty.html" class="nav-tty">TTY</a></li>
<li><a href="dgram.html" class="nav-dgram">UDP/Datagram</a></li>
<li><a href="url.html" class="nav-url">URL</a></li>
<li><a href="util.html" class="nav-util">Utilities</a></li>
<li><a href="v8.html" class="nav-v8">V8</a></li>
<li><a href="vm.html" class="nav-vm">VM</a></li>
<li><a href="worker_threads.html" class="nav-worker_threads">Worker Threads</a></li>
<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
</ul>
<div class="line"></div>
<ul>
<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">GitHub Repo & Issue Tracker</a></li>
</ul>
</div>
<div id="column1" data-id="esm" class="interior">
<header>
<h1>Node.js v13.0.1 Documentation</h1>
<div id="gtoc">
<ul>
<li>
<a href="index.html" name="toc">Index</a>
</li>
<li>
<a href="all.html">View on single page</a>
</li>
<li>
<a href="esm.json">View as JSON</a>
</li>
<li class="version-picker">
<a href="#">View another version <span>▼</span></a>
<ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v13.x/api/esm.html">13.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v12.x/api/esm.html">12.x <b>LTS</b></a></li>
<li><a href="https://nodejs.org/docs/latest-v11.x/api/esm.html">11.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v10.x/api/esm.html">10.x <b>LTS</b></a></li>
<li><a href="https://nodejs.org/docs/latest-v9.x/api/esm.html">9.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v8.x/api/esm.html">8.x <b>LTS</b></a></li></ol>
</li>
<li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/esm.md"><span class="github_icon"><svg height="16" width="16" viewBox="0 0 16.1 16.1" fill="currentColor"><path d="M8 0a8 8 0 0 0-2.5 15.6c.4 0 .5-.2.5-.4v-1.5c-2 .4-2.5-.5-2.7-1 0-.1-.5-.9-.8-1-.3-.2-.7-.6 0-.6.6 0 1 .6 1.2.8.7 1.2 1.9 1 2.4.7 0-.5.2-.9.5-1-1.8-.3-3.7-1-3.7-4 0-.9.3-1.6.8-2.2 0-.2-.3-1 .1-2 0 0 .7-.3 2.2.7a7.4 7.4 0 0 1 4 0c1.5-1 2.2-.8 2.2-.8.5 1.1.2 2 .1 2.1.5.6.8 1.3.8 2.2 0 3-1.9 3.7-3.6 4 .3.2.5.7.5 1.4v2.2c0 .2.1.5.5.4A8 8 0 0 0 16 8a8 8 0 0 0-8-8z"/></svg></span>Edit on GitHub</a></li>
</ul>
</div>
<hr>
</header>
<div id="toc">
<h2>Table of Contents</h2>
<ul>
<li>
<p><span class="stability_1"><a href="#esm_ecmascript_modules">ECMAScript Modules</a></span></p>
<ul>
<li><a href="#esm_introduction">Introduction</a></li>
<li>
<p><a href="#esm_enabling">Enabling</a></p>
<ul>
<li><a href="#esm_code_package_json_code_code_type_code_field"><code>package.json</code> <code>"type"</code> field</a></li>
<li><a href="#esm_package_scope_and_file_extensions">Package Scope and File Extensions</a></li>
<li><a href="#esm_code_input_type_code_flag"><code>--input-type</code> flag</a></li>
</ul>
</li>
<li>
<p><a href="#esm_packages">Packages</a></p>
<ul>
<li>
<p><a href="#esm_package_entry_points">Package Entry Points</a></p>
<ul>
<li><a href="#esm_compatibility_with_commonjs_only_versions_of_node_js">Compatibility with CommonJS-Only Versions of Node.js</a></li>
</ul>
</li>
<li><a href="#esm_package_exports">Package Exports</a></li>
</ul>
</li>
<li>
<p><a href="#esm_code_import_code_specifiers"><code>import</code> Specifiers</a></p>
<ul>
<li>
<p><a href="#esm_terminology">Terminology</a></p>
<ul>
<li><a href="#esm_data_imports"><code>data:</code> Imports</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#esm_import_meta">import.meta</a></li>
<li>
<p><a href="#esm_differences_between_es_modules_and_commonjs">Differences Between ES Modules and CommonJS</a></p>
<ul>
<li><a href="#esm_mandatory_file_extensions">Mandatory file extensions</a></li>
<li><a href="#esm_no_code_node_path_code">No <code>NODE_PATH</code></a></li>
<li><a href="#esm_no_code_require_code_code_exports_code_code_module_exports_code_code_filename_code_code_dirname_code">No <code>require</code>, <code>exports</code>, <code>module.exports</code>, <code>__filename</code>, <code>__dirname</code></a></li>
<li><a href="#esm_no_code_require_extensions_code">No <code>require.extensions</code></a></li>
<li><a href="#esm_no_code_require_cache_code">No <code>require.cache</code></a></li>
<li><a href="#esm_url_based_paths">URL-based paths</a></li>
</ul>
</li>
<li>
<p><a href="#esm_interoperability_with_commonjs">Interoperability with CommonJS</a></p>
<ul>
<li><a href="#esm_code_require_code"><code>require</code></a></li>
<li><a href="#esm_code_import_code_statements"><code>import</code> statements</a></li>
<li><a href="#esm_code_import_code_expressions"><code>import()</code> expressions</a></li>
</ul>
</li>
<li><a href="#esm_commonjs_json_and_native_modules">CommonJS, JSON, and Native Modules</a></li>
<li><a href="#esm_builtin_modules">Builtin modules</a></li>
<li><a href="#esm_experimental_json_modules">Experimental JSON Modules</a></li>
<li><a href="#esm_experimental_wasm_modules">Experimental Wasm Modules</a></li>
<li>
<p><a href="#esm_experimental_loader_hooks">Experimental Loader hooks</a></p>
<ul>
<li><a href="#esm_resolve_hook">Resolve hook</a></li>
<li><a href="#esm_dynamic_instantiate_hook">Dynamic instantiate hook</a></li>
</ul>
</li>
<li>
<p><a href="#esm_resolution_algorithm">Resolution Algorithm</a></p>
<ul>
<li><a href="#esm_features">Features</a></li>
<li><a href="#esm_resolver_algorithm">Resolver Algorithm</a></li>
<li><a href="#esm_customizing_esm_specifier_resolution_algorithm">Customizing ESM specifier resolution algorithm</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div id="apicontent">
<h1>ECMAScript Modules<span><a class="mark" href="#esm_ecmascript_modules" id="esm_ecmascript_modules">#</a></span></h1>
<p></p><div class="api_stability api_stability_1"><a href="documentation.html#documentation_stability_index">Stability: 1</a> - Experimental</div><p></p>
<h2>Introduction<span><a class="mark" href="#esm_introduction" id="esm_introduction">#</a></span></h2>
<p>ECMAScript modules are <a href="https://tc39.github.io/ecma262/#sec-modules">the official standard format</a> to package JavaScript
code for reuse. Modules are defined using a variety of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import"><code>import</code></a> and
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export"><code>export</code></a> statements.</p>
<p>Node.js fully supports ECMAScript modules as they are currently specified and
provides limited interoperability between them and the existing module format,
<a href="modules.html">CommonJS</a>.</p>
<p>Node.js contains support for ES Modules based upon the
<a href="https://github.com/nodejs/node-eps/blob/master/002-es-modules.md">Node.js EP for ES Modules</a> and the <a href="https://github.com/nodejs/modules/blob/master/doc/plan-for-new-modules-implementation.md">ECMAScript-modules implementation</a>.</p>
<p>Expect major changes in the implementation including interoperability support,
specifier resolution, and default behavior.</p>
<h2>Enabling<span><a class="mark" href="#esm_enabling" id="esm_enabling">#</a></span></h2>
<p>The <code>--experimental-modules</code> flag can be used to enable support for
ECMAScript modules (ES modules).</p>
<p>Once enabled, Node.js will treat the following as ES modules when passed to
<code>node</code> as the initial input, or when referenced by <code>import</code> statements within
ES module code:</p>
<ul>
<li>
<p>Files ending in <code>.mjs</code>.</p>
</li>
<li>
<p>Files ending in <code>.js</code>, or extensionless files, when the nearest parent
<code>package.json</code> file contains a top-level field <code>"type"</code> with a value of
<code>"module"</code>.</p>
</li>
<li>
<p>Strings passed in as an argument to <code>--eval</code> or <code>--print</code>, or piped to
<code>node</code> via <code>STDIN</code>, with the flag <code>--input-type=module</code>.</p>
</li>
</ul>
<p>Node.js will treat as CommonJS all other forms of input, such as <code>.js</code> files
where the nearest parent <code>package.json</code> file contains no top-level <code>"type"</code>
field, or string input without the flag <code>--input-type</code>. This behavior is to
preserve backward compatibility. However, now that Node.js supports both
CommonJS and ES modules, it is best to be explicit whenever possible. Node.js
will treat the following as CommonJS when passed to <code>node</code> as the initial input,
or when referenced by <code>import</code> statements within ES module code:</p>
<ul>
<li>
<p>Files ending in <code>.cjs</code>.</p>
</li>
<li>
<p>Files ending in <code>.js</code>, or extensionless files, when the nearest parent
<code>package.json</code> file contains a top-level field <code>"type"</code> with a value of
<code>"commonjs"</code>.</p>
</li>
<li>
<p>Strings passed in as an argument to <code>--eval</code> or <code>--print</code>, or piped to
<code>node</code> via <code>STDIN</code>, with the flag <code>--input-type=commonjs</code>.</p>
</li>
</ul>
<h3><code>package.json</code> <code>"type"</code> field<span><a class="mark" href="#esm_code_package_json_code_code_type_code_field" id="esm_code_package_json_code_code_type_code_field">#</a></span></h3>
<p>Files ending with <code>.js</code> or <code>.mjs</code>, or lacking any extension,
will be loaded as ES modules when the nearest parent <code>package.json</code> file
contains a top-level field <code>"type"</code> with a value of <code>"module"</code>.</p>
<p>The nearest parent <code>package.json</code> is defined as the first <code>package.json</code> found
when searching in the current folder, that folder’s parent, and so on up
until the root of the volume is reached.</p>
<!-- eslint-skip -->
<pre><code class="language-js">// package.json
{
"type": "module"
}
</code></pre>
<pre><code class="language-sh"># In same folder as above package.json
node --experimental-modules my-app.js # Runs as ES module
</code></pre>
<p>If the nearest parent <code>package.json</code> lacks a <code>"type"</code> field, or contains
<code>"type": "commonjs"</code>, extensionless and <code>.js</code> files are treated as CommonJS.
If the volume root is reached and no <code>package.json</code> is found,
Node.js defers to the default, a <code>package.json</code> with no <code>"type"</code>
field.</p>
<p><code>import</code> statements of <code>.js</code> and extensionless files are treated as ES modules
if the nearest parent <code>package.json</code> contains <code>"type": "module"</code>.</p>
<pre><code class="language-js">// my-app.js, part of the same example as above
import './startup.js'; // Loaded as ES module because of package.json
</code></pre>
<p>Package authors should include the <code>"type"</code> field, even in packages where all
sources are CommonJS. Being explicit about the <code>type</code> of the package will
future-proof the package in case the default type of Node.js ever changes, and
it will also make things easier for build tools and loaders to determine how the
files in the package should be interpreted.</p>
<h3>Package Scope and File Extensions<span><a class="mark" href="#esm_package_scope_and_file_extensions" id="esm_package_scope_and_file_extensions">#</a></span></h3>
<p>A folder containing a <code>package.json</code> file, and all subfolders below that
folder down until the next folder containing another <code>package.json</code>, is
considered a <em>package scope</em>. The <code>"type"</code> field defines how <code>.js</code> and
extensionless files should be treated within a particular <code>package.json</code> file’s
package scope. Every package in a project’s <code>node_modules</code> folder contains its
own <code>package.json</code> file, so each project’s dependencies have their own package
scopes. A <code>package.json</code> lacking a <code>"type"</code> field is treated as if it contained
<code>"type": "commonjs"</code>.</p>
<p>The package scope applies not only to initial entry points (<code>node --experimental-modules my-app.js</code>) but also to files referenced by <code>import</code>
statements and <code>import()</code> expressions.</p>
<pre><code class="language-js">// my-app.js, in an ES module package scope because there is a package.json
// file in the same folder with "type": "module".
import './startup/init.js';
// Loaded as ES module since ./startup contains no package.json file,
// and therefore inherits the ES module package scope from one level up.
import 'commonjs-package';
// Loaded as CommonJS since ./node_modules/commonjs-package/package.json
// lacks a "type" field or contains "type": "commonjs".
import './node_modules/commonjs-package/index.js';
// Loaded as CommonJS since ./node_modules/commonjs-package/package.json
// lacks a "type" field or contains "type": "commonjs".
</code></pre>
<p>Files ending with <code>.mjs</code> are always loaded as ES modules regardless of package
scope.</p>
<p>Files ending with <code>.cjs</code> are always loaded as CommonJS regardless of package
scope.</p>
<pre><code class="language-js">import './legacy-file.cjs';
// Loaded as CommonJS since .cjs is always loaded as CommonJS.
import 'commonjs-package/src/index.mjs';
// Loaded as ES module since .mjs is always loaded as ES module.
</code></pre>
<p>The <code>.mjs</code> and <code>.cjs</code> extensions may be used to mix types within the same
package scope:</p>
<ul>
<li>
<p>Within a <code>"type": "module"</code> package scope, Node.js can be instructed to
interpret a particular file as CommonJS by naming it with a <code>.cjs</code> extension
(since both <code>.js</code> and <code>.mjs</code> files are treated as ES modules within a
<code>"module"</code> package scope).</p>
</li>
<li>
<p>Within a <code>"type": "commonjs"</code> package scope, Node.js can be instructed to
interpret a particular file as an ES module by naming it with an <code>.mjs</code>
extension (since both <code>.js</code> and <code>.cjs</code> files are treated as CommonJS within a
<code>"commonjs"</code> package scope).</p>
</li>
</ul>
<h3><code>--input-type</code> flag<span><a class="mark" href="#esm_code_input_type_code_flag" id="esm_code_input_type_code_flag">#</a></span></h3>
<p>Strings passed in as an argument to <code>--eval</code> or <code>--print</code> (or <code>-e</code> or <code>-p</code>), or
piped to <code>node</code> via <code>STDIN</code>, will be treated as ES modules when the
<code>--input-type=module</code> flag is set.</p>
<pre><code class="language-sh">node --experimental-modules --input-type=module --eval \
"import { sep } from 'path'; console.log(sep);"
echo "import { sep } from 'path'; console.log(sep);" | \
node --experimental-modules --input-type=module
</code></pre>
<p>For completeness there is also <code>--input-type=commonjs</code>, for explicitly running
string input as CommonJS. This is the default behavior if <code>--input-type</code> is
unspecified.</p>
<h2>Packages<span><a class="mark" href="#esm_packages" id="esm_packages">#</a></span></h2>
<h3>Package Entry Points<span><a class="mark" href="#esm_package_entry_points" id="esm_package_entry_points">#</a></span></h3>
<p>The <code>package.json</code> <code>"main"</code> field defines the entry point for a package,
whether the package is included into CommonJS via <code>require</code> or into an ES
module via <code>import</code>.</p>
<!-- eslint-skip -->
<pre><code class="language-js">// ./node_modules/es-module-package/package.json
{
"type": "module",
"main": "./src/index.js"
}
</code></pre>
<pre><code class="language-js">// ./my-app.mjs
import { something } from 'es-module-package';
// Loads from ./node_modules/es-module-package/src/index.js
</code></pre>
<p>An attempt to <code>require</code> the above <code>es-module-package</code> would attempt to load
<code>./node_modules/es-module-package/src/index.js</code> as CommonJS, which would throw
an error as Node.js would not be able to parse the <code>export</code> statement in
CommonJS.</p>
<p>As with <code>import</code> statements, for ES module usage the value of <code>"main"</code> must be
a full path including extension: <code>"./index.mjs"</code>, not <code>"./index"</code>.</p>
<p>If the <code>package.json</code> <code>"type"</code> field is omitted, a <code>.js</code> file in <code>"main"</code> will
be interpreted as CommonJS.</p>
<p>The <code>"main"</code> field can point to exactly one file, regardless of whether the
package is referenced via <code>require</code> (in a CommonJS context) or <code>import</code> (in an
ES module context).</p>
<h4>Compatibility with CommonJS-Only Versions of Node.js<span><a class="mark" href="#esm_compatibility_with_commonjs_only_versions_of_node_js" id="esm_compatibility_with_commonjs_only_versions_of_node_js">#</a></span></h4>
<p>Prior to the introduction of support for ES modules in Node.js, it was a common
pattern for package authors to include both CommonJS and ES module JavaScript
sources in their package, with <code>package.json</code> <code>"main"</code> specifying the CommonJS
entry point and <code>package.json</code> <code>"module"</code> specifying the ES module entry point.
This enabled Node.js to run the CommonJS entry point while build tools such as
bundlers used the ES module entry point, since Node.js ignored (and still
ignores) <code>"module"</code>.</p>
<p>Node.js can now run ES module entry points, but it remains impossible for a
package to define separate CommonJS and ES module entry points. This is for good
reason: the <code>pkg</code> variable created from <code>import pkg from 'pkg'</code> is not the same
singleton as the <code>pkg</code> variable created from <code>const pkg = require('pkg')</code>, so if
both are referenced within the same app (including dependencies), unexpected
behavior might occur.</p>
<p>There are two general approaches to addressing this limitation while still
publishing a package that contains both CommonJS and ES module sources:</p>
<ol>
<li>
<p>Document a new ES module entry point that’s not the package <code>"main"</code>, e.g.
<code>import pkg from 'pkg/module.mjs'</code> (or <code>import 'pkg/esm'</code>, if using <a href="#esm_package_exports">package
exports</a>). The package <code>"main"</code> would still point to a CommonJS file, and
thus the package would remain compatible with older versions of Node.js that
lack support for ES modules.</p>
</li>
<li>
<p>Switch the package <code>"main"</code> entry point to an ES module file as part of a
breaking change version bump. This version and above would only be usable on
ES module-supporting versions of Node.js. If the package still contains a
CommonJS version, it would be accessible via a path within the package, e.g.
<code>require('pkg/commonjs')</code>; this is essentially the inverse of the previous
approach. Package consumers who are using CommonJS-only versions of Node.js
would need to update their code from <code>require('pkg')</code> to e.g.
<code>require('pkg/commonjs')</code>.</p>
</li>
</ol>
<p>Of course, a package could also include only CommonJS or only ES module sources.
An existing package could make a semver major bump to an ES module-only version,
that would only be supported in ES module-supporting versions of Node.js (and
other runtimes). New packages could be published containing only ES module
sources, and would be compatible only with ES module-supporting runtimes.</p>
<h3>Package Exports<span><a class="mark" href="#esm_package_exports" id="esm_package_exports">#</a></span></h3>
<p>By default, all subpaths from a package can be imported (<code>import 'pkg/x.js'</code>).
Custom subpath aliasing and encapsulation can be provided through the
<code>"exports"</code> field.</p>
<!-- eslint-skip -->
<pre><code class="language-js">// ./node_modules/es-module-package/package.json
{
"exports": {
"./submodule": "./src/submodule.js"
}
}
</code></pre>
<pre><code class="language-js">import submodule from 'es-module-package/submodule';
// Loads ./node_modules/es-module-package/src/submodule.js
</code></pre>
<p>In addition to defining an alias, subpaths not defined by <code>"exports"</code> will
throw when an attempt is made to import them:</p>
<pre><code class="language-js">import submodule from 'es-module-package/private-module.js';
// Throws - Module not found
</code></pre>
<blockquote>
<p>Note: this is not a strong encapsulation as any private modules can still be
loaded by absolute paths.</p>
</blockquote>
<p>Folders can also be mapped with package exports:</p>
<!-- eslint-skip -->
<pre><code class="language-js">// ./node_modules/es-module-package/package.json
{
"exports": {
"./features/": "./src/features/"
}
}
</code></pre>
<pre><code class="language-js">import feature from 'es-module-package/features/x.js';
// Loads ./node_modules/es-module-package/src/features/x.js
</code></pre>
<p>If a package has no exports, setting <code>"exports": false</code> can be used instead of
<code>"exports": {}</code> to indicate the package does not intend for submodules to be
exposed.</p>
<p>Exports can also be used to map the main entry point of a package:</p>
<!-- eslint-skip -->
<pre><code class="language-js">// ./node_modules/es-module-package/package.json
{
"exports": {
".": "./main.js"
}
}
</code></pre>
<p>where the "." indicates loading the package without any subpath. Exports will
always override any existing <code>"main"</code> value for both CommonJS and
ES module packages.</p>
<p>For packages with only a main entry point, an <code>"exports"</code> value of just
a string is also supported:</p>
<!-- eslint-skip -->
<pre><code class="language-js">// ./node_modules/es-module-package/package.json
{
"exports": "./main.js"
}
</code></pre>
<p>Any invalid exports entries will be ignored. This includes exports not
starting with <code>"./"</code> or a missing trailing <code>"/"</code> for directory exports.</p>
<p>Array fallback support is provided for exports, similarly to import maps
in order to be forward-compatible with fallback workflows in future:</p>
<!-- eslint-skip -->
<pre><code class="language-js">{
"exports": {
"./submodule": ["not:valid", "./submodule.js"]
}
}
</code></pre>
<p>Since <code>"not:valid"</code> is not a supported target, <code>"./submodule.js"</code> is used
instead as the fallback, as if it were the only target.</p>
<h2><code>import</code> Specifiers<span><a class="mark" href="#esm_code_import_code_specifiers" id="esm_code_import_code_specifiers">#</a></span></h2>
<h3>Terminology<span><a class="mark" href="#esm_terminology" id="esm_terminology">#</a></span></h3>
<p>The <em>specifier</em> of an <code>import</code> statement is the string after the <code>from</code> keyword,
e.g. <code>'path'</code> in <code>import { sep } from 'path'</code>. Specifiers are also used in
<code>export from</code> statements, and as the argument to an <code>import()</code> expression.</p>
<p>There are four types of specifiers:</p>
<ul>
<li>
<p><em>Bare specifiers</em> like <code>'some-package'</code>. They refer to an entry point of a
package by the package name.</p>
</li>
<li>
<p><em>Deep import specifiers</em> like <code>'some-package/lib/shuffle.mjs'</code>. They refer to
a path within a package prefixed by the package name.</p>
</li>
<li>
<p><em>Relative specifiers</em> like <code>'./startup.js'</code> or <code>'../config.mjs'</code>. They refer
to a path relative to the location of the importing file.</p>
</li>
<li>
<p><em>Absolute specifiers</em> like <code>'file:///opt/nodejs/config.js'</code>. They refer
directly and explicitly to a full path.</p>
</li>
</ul>
<p>Bare specifiers, and the bare specifier portion of deep import specifiers, are
strings; but everything else in a specifier is a URL.</p>
<p>Only <code>file:</code> and <code>data:</code> URLs are supported. A specifier like
<code>'https://example.com/app.js'</code> may be supported by browsers but it is not
supported in Node.js.</p>
<p>Specifiers may not begin with <code>/</code> or <code>//</code>. These are reserved for potential
future use. The root of the current volume may be referenced via <code>file:///</code>.</p>
<h4><code>data:</code> Imports<span><a class="mark" href="#esm_data_imports" id="esm_data_imports">#</a></span></h4>
<div class="api_metadata">
<span>Added in: v12.10.0</span>
</div>
<p><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"><code>data:</code> URLs</a> are supported for importing with the following MIME types:</p>
<ul>
<li><code>text/javascript</code> for ES Modules</li>
<li><code>application/json</code> for JSON</li>
<li><code>application/wasm</code> for WASM.</li>
</ul>
<p><code>data:</code> URLs only resolve <a href="#esm_terminology"><em>Bare specifiers</em></a> for builtin modules
and <a href="#esm_terminology"><em>Absolute specifiers</em></a>. Resolving
<a href="#esm_terminology"><em>Relative specifiers</em></a> will not work because <code>data:</code> is not a
<a href="https://url.spec.whatwg.org/#special-scheme">special scheme</a>. For example, attempting to load <code>./foo</code>
from <code>data:text/javascript,import "./foo";</code> will fail to resolve since there
is no concept of relative resolution for <code>data:</code> URLs. An example of a <code>data:</code>
URLs being used is:</p>
<pre><code class="language-js">import 'data:text/javascript,console.log("hello!");';
import _ from 'data:application/json,"world!"';
</code></pre>
<h2>import.meta<span><a class="mark" href="#esm_import_meta" id="esm_import_meta">#</a></span></h2>
<ul>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li>
</ul>
<p>The <code>import.meta</code> metaproperty is an <code>Object</code> that contains the following
property:</p>
<ul>
<li><code>url</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The absolute <code>file:</code> URL of the module.</li>
</ul>
<h2>Differences Between ES Modules and CommonJS<span><a class="mark" href="#esm_differences_between_es_modules_and_commonjs" id="esm_differences_between_es_modules_and_commonjs">#</a></span></h2>
<h3>Mandatory file extensions<span><a class="mark" href="#esm_mandatory_file_extensions" id="esm_mandatory_file_extensions">#</a></span></h3>
<p>A file extension must be provided when using the <code>import</code> keyword. Directory
indexes (e.g. <code>'./startup/index.js'</code>) must also be fully specified.</p>
<p>This behavior matches how <code>import</code> behaves in browser environments, assuming a
typically configured server.</p>
<h3>No <code>NODE_PATH</code><span><a class="mark" href="#esm_no_code_node_path_code" id="esm_no_code_node_path_code">#</a></span></h3>
<p><code>NODE_PATH</code> is not part of resolving <code>import</code> specifiers. Please use symlinks
if this behavior is desired.</p>
<h3>No <code>require</code>, <code>exports</code>, <code>module.exports</code>, <code>__filename</code>, <code>__dirname</code><span><a class="mark" href="#esm_no_code_require_code_code_exports_code_code_module_exports_code_code_filename_code_code_dirname_code" id="esm_no_code_require_code_code_exports_code_code_module_exports_code_code_filename_code_code_dirname_code">#</a></span></h3>
<p>These CommonJS variables are not available in ES modules.</p>
<p><code>require</code> can be imported into an ES module using <a href="modules.html#modules_module_createrequire_filename"><code>module.createRequire()</code></a>.</p>
<p>Equivalents of <code>__filename</code> and <code>__dirname</code> can be created inside of each file
via <a href="#esm_import_meta"><code>import.meta.url</code></a>.</p>
<pre><code class="language-js">import { fileURLToPath } from 'url';
import { dirname } from 'path';
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
</code></pre>
<h3>No <code>require.extensions</code><span><a class="mark" href="#esm_no_code_require_extensions_code" id="esm_no_code_require_extensions_code">#</a></span></h3>
<p><code>require.extensions</code> is not used by <code>import</code>. The expectation is that loader
hooks can provide this workflow in the future.</p>
<h3>No <code>require.cache</code><span><a class="mark" href="#esm_no_code_require_cache_code" id="esm_no_code_require_cache_code">#</a></span></h3>
<p><code>require.cache</code> is not used by <code>import</code>. It has a separate cache.</p>
<h3>URL-based paths<span><a class="mark" href="#esm_url_based_paths" id="esm_url_based_paths">#</a></span></h3>
<p>ES modules are resolved and cached based upon
<a href="https://url.spec.whatwg.org/">URL</a> semantics. This means that files containing
special characters such as <code>#</code> and <code>?</code> need to be escaped.</p>
<p>Modules will be loaded multiple times if the <code>import</code> specifier used to resolve
them have a different query or fragment.</p>
<pre><code class="language-js">import './foo.mjs?query=1'; // loads ./foo.mjs with query of "?query=1"
import './foo.mjs?query=2'; // loads ./foo.mjs with query of "?query=2"
</code></pre>
<p>For now, only modules using the <code>file:</code> protocol can be loaded.</p>
<h2>Interoperability with CommonJS<span><a class="mark" href="#esm_interoperability_with_commonjs" id="esm_interoperability_with_commonjs">#</a></span></h2>
<h3><code>require</code><span><a class="mark" href="#esm_code_require_code" id="esm_code_require_code">#</a></span></h3>
<p><code>require</code> always treats the files it references as CommonJS. This applies
whether <code>require</code> is used the traditional way within a CommonJS environment, or
in an ES module environment using <a href="modules.html#modules_module_createrequire_filename"><code>module.createRequire()</code></a>.</p>
<p>To include an ES module into CommonJS, use <a href="#esm_import-expressions"><code>import()</code></a>.</p>
<h3><code>import</code> statements<span><a class="mark" href="#esm_code_import_code_statements" id="esm_code_import_code_statements">#</a></span></h3>
<p>An <code>import</code> statement can reference an ES module, a CommonJS module, or JSON.
Other file types such as Native modules are not supported. For those,
use <a href="modules.html#modules_module_createrequire_filename"><code>module.createRequire()</code></a>.</p>
<p><code>import</code> statements are permitted only in ES modules. For similar functionality
in CommonJS, see <a href="#esm_import-expressions"><code>import()</code></a>.</p>
<p>The <em>specifier</em> of an <code>import</code> statement (the string after the <code>from</code> keyword)
can either be an URL-style relative path like <code>'./file.mjs'</code> or a package name
like <code>'fs'</code>.</p>
<p>Like in CommonJS, files within packages can be accessed by appending a path to
the package name.</p>
<pre><code class="language-js">import { sin, cos } from 'geometry/trigonometry-functions.mjs';
</code></pre>
<blockquote>
<p>Currently only the “default export” is supported for CommonJS files or
packages:</p>
<!-- eslint-disable no-duplicate-imports -->
<pre><code class="language-js">import packageMain from 'commonjs-package'; // Works
import { method } from 'commonjs-package'; // Errors
</code></pre>
<p>There are ongoing efforts to make the latter code possible.</p>
</blockquote>
<h3><code>import()</code> expressions<span><a class="mark" href="#esm_code_import_code_expressions" id="esm_code_import_code_expressions">#</a></span></h3>
<p>Dynamic <code>import()</code> is supported in both CommonJS and ES modules. It can be used
to include ES module files from CommonJS code.</p>
<pre><code class="language-js">(async () => {
await import('./my-app.mjs');
})();
</code></pre>
<h2>CommonJS, JSON, and Native Modules<span><a class="mark" href="#esm_commonjs_json_and_native_modules" id="esm_commonjs_json_and_native_modules">#</a></span></h2>
<p>CommonJS, JSON, and Native modules can be used with
<a href="modules.html#modules_module_createrequire_filename"><code>module.createRequire()</code></a>.</p>
<pre><code class="language-js">// cjs.js
module.exports = 'cjs';
// esm.mjs
import { createRequire } from 'module';
import { fileURLToPath as fromURL } from 'url';
const require = createRequire(fromURL(import.meta.url));
const cjs = require('./cjs');
cjs === 'cjs'; // true
</code></pre>
<h2>Builtin modules<span><a class="mark" href="#esm_builtin_modules" id="esm_builtin_modules">#</a></span></h2>
<p>Builtin modules will provide named exports of their public API. A
default export is also provided which is the value of the CommonJS exports.
The default export can be used for, among other things, modifying the named
exports. Named exports of builtin modules are updated only by calling
<a href="modules.html#modules_module_syncbuiltinesmexports"><code>module.syncBuiltinESMExports()</code></a>.</p>
<pre><code class="language-js">import EventEmitter from 'events';
const e = new EventEmitter();
</code></pre>
<pre><code class="language-js">import { readFile } from 'fs';
readFile('./foo.txt', (err, source) => {
if (err) {
console.error(err);
} else {
console.log(source);
}
});
</code></pre>
<pre><code class="language-js">import fs, { readFileSync } from 'fs';
import { syncBuiltinESMExports } from 'module';
fs.readFileSync = () => Buffer.from('Hello, ESM');
syncBuiltinESMExports();
fs.readFileSync === readFileSync;
</code></pre>
<h2>Experimental JSON Modules<span><a class="mark" href="#esm_experimental_json_modules" id="esm_experimental_json_modules">#</a></span></h2>
<p>Currently importing JSON modules are only supported in the <code>commonjs</code> mode
and are loaded using the CJS loader. <a href="https://html.spec.whatwg.org/#creating-a-json-module-script">WHATWG JSON modules specification</a> are
still being standardized, and are experimentally supported by including the
additional flag <code>--experimental-json-modules</code> when running Node.js.</p>
<p>When the <code>--experimental-json-modules</code> flag is included both the
<code>commonjs</code> and <code>module</code> mode will use the new experimental JSON
loader. The imported JSON only exposes a <code>default</code>, there is no
support for named exports. A cache entry is created in the CommonJS
cache, to avoid duplication. The same object will be returned in
CommonJS if the JSON module has already been imported from the
same path.</p>
<p>Assuming an <code>index.mjs</code> with</p>
<!-- eslint-skip -->
<pre><code class="language-js">import packageConfig from './package.json';
</code></pre>
<p>The <code>--experimental-json-modules</code> flag is needed for the module
to work.</p>
<pre><code class="language-bash">node --experimental-modules index.mjs # fails
node --experimental-modules --experimental-json-modules index.mjs # works
</code></pre>
<h2>Experimental Wasm Modules<span><a class="mark" href="#esm_experimental_wasm_modules" id="esm_experimental_wasm_modules">#</a></span></h2>
<p>Importing Web Assembly modules is supported under the
<code>--experimental-wasm-modules</code> flag, allowing any <code>.wasm</code> files to be
imported as normal modules while also supporting their module imports.</p>
<p>This integration is in line with the
<a href="https://github.com/webassembly/esm-integration">ES Module Integration Proposal for Web Assembly</a>.</p>
<p>For example, an <code>index.mjs</code> containing:</p>
<pre><code class="language-js">import * as M from './module.wasm';
console.log(M);
</code></pre>
<p>executed under:</p>
<pre><code class="language-bash">node --experimental-modules --experimental-wasm-modules index.mjs
</code></pre>
<p>would provide the exports interface for the instantiation of <code>module.wasm</code>.</p>
<h2>Experimental Loader hooks<span><a class="mark" href="#esm_experimental_loader_hooks" id="esm_experimental_loader_hooks">#</a></span></h2>
<p><strong>Note: This API is currently being redesigned and will still change.</strong></p>
<p>To customize the default module resolution, loader hooks can optionally be
provided via a <code>--experimental-loader ./loader-name.mjs</code> argument to Node.js.</p>
<p>When hooks are used they only apply to ES module loading and not to any
CommonJS modules loaded.</p>
<h3>Resolve hook<span><a class="mark" href="#esm_resolve_hook" id="esm_resolve_hook">#</a></span></h3>
<p>The resolve hook returns the resolved file URL and module format for a
given module specifier and parent file URL:</p>
<pre><code class="language-js">import { URL, pathToFileURL } from 'url';
const baseURL = pathToFileURL(process.cwd()).href;
/**
* @param {string} specifier
* @param {string} parentModuleURL
* @param {function} defaultResolver
*/
export async function resolve(specifier,
parentModuleURL = baseURL,
defaultResolver) {
return {
url: new URL(specifier, parentModuleURL).href,
format: 'module'
};
}
</code></pre>
<p>The <code>parentModuleURL</code> is provided as <code>undefined</code> when performing main Node.js
load itself.</p>
<p>The default Node.js ES module resolution function is provided as a third
argument to the resolver for easy compatibility workflows.</p>
<p>In addition to returning the resolved file URL value, the resolve hook also
returns a <code>format</code> property specifying the module format of the resolved
module. This can be one of the following:</p>
<table><thead><tr><th><code>format</code></th><th>Description</th></tr></thead><tbody><tr><td><code>'builtin'</code></td><td>Load a Node.js builtin module</td></tr><tr><td><code>'commonjs'</code></td><td>Load a Node.js CommonJS module</td></tr><tr><td><code>'dynamic'</code></td><td>Use a <a href="#esm_dynamic_instantiate_hook">dynamic instantiate hook</a></td></tr><tr><td><code>'json'</code></td><td>Load a JSON file</td></tr><tr><td><code>'module'</code></td><td>Load a standard JavaScript module</td></tr><tr><td><code>'wasm'</code></td><td>Load a WebAssembly module</td></tr></tbody></table>
<p>For example, a dummy loader to load JavaScript restricted to browser resolution
rules with only JS file extension and Node.js builtin modules support could
be written:</p>
<pre><code class="language-js">import path from 'path';
import process from 'process';
import Module from 'module';
import { URL, pathToFileURL } from 'url';
const builtins = Module.builtinModules;
const JS_EXTENSIONS = new Set(['.js', '.mjs']);
const baseURL = pathToFileURL(process.cwd()).href;
/**
* @param {string} specifier
* @param {string} parentModuleURL
* @param {function} defaultResolver
*/
export async function resolve(specifier,
parentModuleURL = baseURL,
defaultResolver) {
if (builtins.includes(specifier)) {
return {
url: specifier,
format: 'builtin'
};
}
if (/^\.{0,2}[/]/.test(specifier) !== true && !specifier.startsWith('file:')) {
// For node_modules support:
// return defaultResolver(specifier, parentModuleURL);
throw new Error(
`imports must begin with '/', './', or '../'; '${specifier}' does not`);
}
const resolved = new URL(specifier, parentModuleURL);
const ext = path.extname(resolved.pathname);
if (!JS_EXTENSIONS.has(ext)) {
throw new Error(
`Cannot load file with non-JavaScript file extension ${ext}.`);
}
return {
url: resolved.href,
format: 'module'
};
}
</code></pre>
<p>With this loader, running:</p>
<pre><code class="language-console">NODE_OPTIONS='--experimental-modules --experimental-loader ./custom-loader.mjs' node x.js
</code></pre>
<p>would load the module <code>x.js</code> as an ES module with relative resolution support
(with <code>node_modules</code> loading skipped in this example).</p>
<h3>Dynamic instantiate hook<span><a class="mark" href="#esm_dynamic_instantiate_hook" id="esm_dynamic_instantiate_hook">#</a></span></h3>
<p>To create a custom dynamic module that doesn't correspond to one of the
existing <code>format</code> interpretations, the <code>dynamicInstantiate</code> hook can be used.
This hook is called only for modules that return <code>format: 'dynamic'</code> from
the <code>resolve</code> hook.</p>
<pre><code class="language-js">export async function dynamicInstantiate(url) {
return {
exports: ['customExportName'],
execute: (exports) => {
// Get and set functions provided for pre-allocated export names
exports.customExportName.set('value');
}
};
}
</code></pre>
<p>With the list of module exports provided upfront, the <code>execute</code> function will
then be called at the exact point of module evaluation order for that module
in the import tree.</p>
<h2>Resolution Algorithm<span><a class="mark" href="#esm_resolution_algorithm" id="esm_resolution_algorithm">#</a></span></h2>
<h3>Features<span><a class="mark" href="#esm_features" id="esm_features">#</a></span></h3>
<p>The resolver has the following properties:</p>
<ul>
<li>FileURL-based resolution as is used by ES modules</li>
<li>Support for builtin module loading</li>
<li>Relative and absolute URL resolution</li>
<li>No default extensions</li>
<li>No folder mains</li>
<li>Bare specifier package resolution lookup through node_modules</li>
</ul>
<h3>Resolver Algorithm<span><a class="mark" href="#esm_resolver_algorithm" id="esm_resolver_algorithm">#</a></span></h3>
<p>The algorithm to load an ES module specifier is given through the
<strong>ESM_RESOLVE</strong> method below. It returns the resolved URL for a
module specifier relative to a parentURL, in addition to the unique module
format for that resolved URL given by the <strong>ESM_FORMAT</strong> routine.</p>
<p>The <em>"module"</em> format is returned for an ECMAScript Module, while the
<em>"commonjs"</em> format is used to indicate loading through the legacy
CommonJS loader. Additional formats such as <em>"addon"</em> can be extended in future
updates.</p>
<p>In the following algorithms, all subroutine errors are propagated as errors
of these top-level routines unless stated otherwise.</p>
<p><em>isMain</em> is <strong>true</strong> when resolving the Node.js application entry point.</p>
<details>
<summary>Resolver algorithm specification</summary>
<p><strong>ESM_RESOLVE</strong>(<em>specifier</em>, <em>parentURL</em>, <em>isMain</em>)</p>
<blockquote>
<ol>
<li>Let <em>resolvedURL</em> be <strong>undefined</strong>.</li>
<li>
<p>If <em>specifier</em> is a valid URL, then</p>
<ol>
<li>Set <em>resolvedURL</em> to the result of parsing and reserializing
<em>specifier</em> as a URL.</li>
</ol>
</li>
<li>
<p>Otherwise, if <em>specifier</em> starts with <em>"/"</em>, then</p>
<ol>
<li>Throw an <em>Invalid Specifier</em> error.</li>
</ol>
</li>
<li>
<p>Otherwise, if <em>specifier</em> starts with <em>"./"</em> or <em>"../"</em>, then</p>
<ol>
<li>Set <em>resolvedURL</em> to the URL resolution of <em>specifier</em> relative to
<em>parentURL</em>.</li>
</ol>
</li>
<li>
<p>Otherwise,</p>
<ol>
<li>Note: <em>specifier</em> is now a bare specifier.</li>
<li>Set <em>resolvedURL</em> the result of
<strong>PACKAGE_RESOLVE</strong>(<em>specifier</em>, <em>parentURL</em>).</li>
</ol>
</li>
<li>
<p>If <em>resolvedURL</em> contains any percent encodings of <em>"/"</em> or <em>"\"</em> (<em>"%2f"</em>
and <em>"%5C"</em> respectively), then</p>
<ol>
<li>Throw an <em>Invalid Specifier</em> error.</li>
</ol>
</li>
<li>
<p>If the file at <em>resolvedURL</em> does not exist, then</p>
<ol>
<li>Throw a <em>Module Not Found</em> error.</li>
</ol>
</li>
<li>Set <em>resolvedURL</em> to the real path of <em>resolvedURL</em>.</li>
<li>Let <em>format</em> be the result of <strong>ESM_FORMAT</strong>(<em>resolvedURL</em>, <em>isMain</em>).</li>
<li>Load <em>resolvedURL</em> as module format, <em>format</em>.</li>
</ol>
</blockquote>
<p><strong>PACKAGE_RESOLVE</strong>(<em>packageSpecifier</em>, <em>parentURL</em>)</p>
<blockquote>
<ol>
<li>Let <em>packageName</em> be <em>undefined</em>.</li>
<li>Let <em>packageSubpath</em> be <em>undefined</em>.</li>
<li>
<p>If <em>packageSpecifier</em> is an empty string, then</p>
<ol>
<li>Throw an <em>Invalid Specifier</em> error.</li>
</ol>
</li>
<li>
<p>If <em>packageSpecifier</em> does not start with <em>"@"</em>, then</p>
<ol>
<li>Set <em>packageName</em> to the substring of <em>packageSpecifier</em> until the
first <em>"/"</em> separator or the end of the string.</li>
</ol>
</li>
<li>
<p>Otherwise,</p>
<ol>
<li>
<p>If <em>packageSpecifier</em> does not contain a <em>"/"</em> separator, then</p>
<ol>
<li>Throw an <em>Invalid Specifier</em> error.</li>
</ol>
</li>
<li>Set <em>packageName</em> to the substring of <em>packageSpecifier</em>
until the second <em>"/"</em> separator or the end of the string.</li>
</ol>
</li>
<li>
<p>If <em>packageName</em> starts with <em>"."</em> or contains <em>"\"</em> or <em>"%"</em>, then</p>
<ol>
<li>Throw an <em>Invalid Specifier</em> error.</li>
</ol>
</li>
<li>Let <em>packageSubpath</em> be <em>undefined</em>.</li>
<li>
<p>If the length of <em>packageSpecifier</em> is greater than the length of
<em>packageName</em>, then</p>
<ol>
<li>Set <em>packageSubpath</em> to <em>"."</em> concatenated with the substring of
<em>packageSpecifier</em> from the position at the length of <em>packageName</em>.</li>
</ol>
</li>
<li>
<p>If <em>packageSubpath</em> contains any <em>"."</em> or <em>".."</em> segments or percent
encoded strings for <em>"/"</em> or <em>"\"</em> then,</p>
<ol>
<li>Throw an <em>Invalid Specifier</em> error.</li>
</ol>
</li>
<li>
<p>If <em>packageSubpath</em> is <em>undefined</em> and <em>packageName</em> is a Node.js builtin
module, then</p>
<ol>
<li>Return the string <em>"node:"</em> concatenated with <em>packageSpecifier</em>.</li>
</ol>
</li>
<li>
<p>While <em>parentURL</em> is not the file system root,</p>
<ol>
<li>Let <em>packageURL</em> be the URL resolution of <em>"node_modules/"</em>
concatenated with <em>packageSpecifier</em>, relative to <em>parentURL</em>.</li>
<li>Set <em>parentURL</em> to the parent folder URL of <em>parentURL</em>.</li>
<li>
<p>If the folder at <em>packageURL</em> does not exist, then</p>
<ol>
<li>Set <em>parentURL</em> to the parent URL path of <em>parentURL</em>.</li>
<li>Continue the next loop iteration.</li>
</ol>
</li>
<li>Let <em>pjson</em> be the result of <strong>READ_PACKAGE_JSON</strong>(<em>packageURL</em>).</li>
<li>
<p>If <em>packageSubpath</em> is _undefined__, then</p>
<ol>
<li>Return the result of <strong>PACKAGE_MAIN_RESOLVE</strong>(<em>packageURL</em>,
<em>pjson</em>).</li>
</ol>
</li>
<li>
<p>Otherwise,</p>
<ol>
<li>
<p>If <em>pjson</em> is not <strong>null</strong> and <em>pjson</em> has an <em>"exports"</em> key, then</p>
<ol>
<li>Let <em>exports</em> be <em>pjson.exports</em>.</li>
<li>
<p>If <em>exports</em> is not <strong>null</strong> or <strong>undefined</strong>, then</p>
<ol>
<li>Return <strong>PACKAGE_EXPORTS_RESOLVE</strong>(<em>packageURL</em>,
<em>packageSubpath</em>, <em>pjson.exports</em>).</li>
</ol>
</li>
</ol>
</li>
<li>Return the URL resolution of <em>packageSubpath</em> in <em>packageURL</em>.</li>
</ol>
</li>
</ol>
</li>
<li>Throw a <em>Module Not Found</em> error.</li>
</ol>
</blockquote>
<p><strong>PACKAGE_MAIN_RESOLVE</strong>(<em>packageURL</em>, <em>pjson</em>)</p>
<blockquote>
<ol>
<li>
<p>If <em>pjson</em> is <strong>null</strong>, then</p>
<ol>
<li>Throw a <em>Module Not Found</em> error.</li>
</ol>
</li>
<li>
<p>If <em>pjson.exports</em> is not <strong>null</strong> or <strong>undefined</strong>, then</p>
<ol>
<li>
<p>If <em>pjson.exports</em> is a String or Array, then</p>
<ol>
<li>Return <strong>PACKAGE_EXPORTS_TARGET_RESOLVE</strong>(<em>packageURL</em>,
<em>pjson.exports</em>, "")_.</li>
</ol>
</li>
<li>
<p>If _pjson.exports is an Object, then</p>
<ol>
<li>
<p>If <em>pjson.exports</em> contains a <em>"."</em> property, then</p>
<ol>
<li>Let <em>mainExport</em> be the <em>"."</em> property in <em>pjson.exports</em>.</li>
<li>Return <strong>PACKAGE_EXPORTS_TARGET_RESOLVE</strong>(<em>packageURL</em>,
<em>mainExport</em>, "")_.</li>
</ol>
</li>
</ol>
</li>
</ol>
</li>
<li>
<p>If <em>pjson.main</em> is a String, then</p>
<ol>
<li>Let <em>resolvedMain</em> be the URL resolution of <em>packageURL</em>, "/", and
<em>pjson.main</em>.</li>
<li>
<p>If the file at <em>resolvedMain</em> exists, then</p>
<ol>
<li>Return <em>resolvedMain</em>.</li>
</ol>
</li>
</ol>
</li>
<li>
<p>If <em>pjson.type</em> is equal to <em>"module"</em>, then</p>
<ol>
<li>Throw a <em>Module Not Found</em> error.</li>
</ol>
</li>
<li>Let <em>legacyMainURL</em> be the result applying the legacy
<strong>LOAD_AS_DIRECTORY</strong> CommonJS resolver to <em>packageURL</em>, throwing a
<em>Module Not Found</em> error for no resolution.</li>
<li>Return <em>legacyMainURL</em>.</li>
</ol>
</blockquote>
<p><strong>PACKAGE_EXPORTS_RESOLVE</strong>(<em>packageURL</em>, <em>packagePath</em>, <em>exports</em>)</p>
<blockquote>
<ol>
<li>
<p>If <em>exports</em> is an Object, then</p>
<ol>
<li>Set <em>packagePath</em> to <em>"./"</em> concatenated with <em>packagePath</em>.</li>
<li>
<p>If <em>packagePath</em> is a key of <em>exports</em>, then</p>
<ol>
<li>Let <em>target</em> be the value of <em>exports[packagePath]</em>.</li>
<li>Return <strong>PACKAGE_EXPORTS_TARGET_RESOLVE</strong>(<em>packageURL</em>, <em>target</em>,
<em>""</em>).</li>
</ol>
</li>
<li>Let <em>directoryKeys</em> be the list of keys of <em>exports</em> ending in
<em>"/"</em>, sorted by length descending.</li>
<li>
<p>For each key <em>directory</em> in <em>directoryKeys</em>, do</p>
<ol>
<li>
<p>If <em>packagePath</em> starts with <em>directory</em>, then</p>
<ol>
<li>Let <em>target</em> be the value of <em>exports[directory]</em>.</li>
<li>Let <em>subpath</em> be the substring of <em>target</em> starting at the index
of the length of <em>directory</em>.</li>
<li>Return <strong>PACKAGE_EXPORTS_TARGET_RESOLVE</strong>(<em>packageURL</em>, <em>target</em>,
<em>subpath</em>).</li>
</ol>
</li>
</ol>
</li>
</ol>
</li>
<li>Throw a <em>Module Not Found</em> error.</li>
</ol>
</blockquote>
<p><strong>PACKAGE_EXPORTS_TARGET_RESOLVE</strong>(<em>packageURL</em>, <em>target</em>, <em>subpath</em>)</p>
<blockquote>
<ol>
<li>
<p>If <em>target</em> is a String, then</p>
<ol>
<li>If <em>target</em> does not start with <em>"./"</em>, throw a <em>Module Not Found</em>
error.</li>
<li>If <em>subpath</em> has non-zero length and <em>target</em> does not end with <em>"/"</em>,
throw a <em>Module Not Found</em> error.</li>
<li>If <em>target</em> or <em>subpath</em> contain any <em>"node_modules"</em> segments including
<em>"node_modules"</em> percent-encoding, throw a <em>Module Not Found</em> error.</li>
<li>Let <em>resolvedTarget</em> be the URL resolution of the concatenation of
<em>packageURL</em> and <em>target</em>.</li>
<li>
<p>If <em>resolvedTarget</em> is contained in <em>packageURL</em>, then</p>
<ol>
<li>Let <em>resolved</em> be the URL resolution of the concatenation of
<em>subpath</em> and <em>resolvedTarget</em>.</li>
<li>
<p>If <em>resolved</em> is contained in <em>resolvedTarget</em>, then</p>
<ol>
<li>Return <em>resolved</em>.</li>
</ol>
</li>
</ol>
</li>
</ol>
</li>
<li>
<p>Otherwise, if <em>target</em> is an Array, then</p>
<ol>
<li>
<p>For each item <em>targetValue</em> in <em>target</em>, do</p>
<ol>
<li>If <em>targetValue</em> is not a String, continue the loop.</li>
<li>Let <em>resolved</em> be the result of
<strong>PACKAGE_EXPORTS_TARGET_RESOLVE</strong>(<em>packageURL</em>, <em>targetValue</em>,
<em>subpath</em>), continuing the loop on abrupt completion.</li>
<li>Assert: <em>resolved</em> is a String.</li>
<li>Return <em>resolved</em>.</li>
</ol>
</li>
</ol>
</li>
<li>Throw a <em>Module Not Found</em> error.</li>
</ol>
</blockquote>
<p><strong>ESM_FORMAT</strong>(<em>url</em>, <em>isMain</em>)</p>
<blockquote>
<ol>
<li>Assert: <em>url</em> corresponds to an existing file.</li>
<li>Let <em>pjson</em> be the result of <strong>READ_PACKAGE_SCOPE</strong>(<em>url</em>).</li>
<li>
<p>If <em>url</em> ends in <em>".mjs"</em>, then</p>
<ol>
<li>Return <em>"module"</em>.</li>
</ol>
</li>
<li>
<p>If <em>url</em> ends in <em>".cjs"</em>, then</p>
<ol>
<li>Return <em>"commonjs"</em>.</li>
</ol>
</li>
<li>
<p>If <em>pjson?.type</em> exists and is <em>"module"</em>, then</p>
<ol>
<li>
<p>If <em>isMain</em> is <strong>true</strong> or <em>url</em> ends in <em>".js"</em>, then</p>
<ol>
<li>Return <em>"module"</em>.</li>
</ol>
</li>
<li>Throw an <em>Unsupported File Extension</em> error.</li>
</ol>
</li>
<li>
<p>Otherwise,</p>
<ol>
<li>
<p>If <em>isMain</em> is <strong>true</strong> or <em>url</em> ends in <em>".js"</em>, <em>".json"</em> or
<em>".node"</em>, then</p>
<ol>
<li>Return <em>"commonjs"</em>.</li>
</ol>
</li>
<li>Throw an <em>Unsupported File Extension</em> error.</li>
</ol>
</li>
</ol>
</blockquote>
<p><strong>READ_PACKAGE_SCOPE</strong>(<em>url</em>)</p>
<blockquote>
<ol>
<li>Let <em>scopeURL</em> be <em>url</em>.</li>
<li>
<p>While <em>scopeURL</em> is not the file system root,</p>
<ol>
<li>If <em>scopeURL</em> ends in a <em>"node_modules"</em> path segment, return <strong>null</strong>.</li>
<li>Let <em>pjson</em> be the result of <strong>READ_PACKAGE_JSON</strong>(<em>scopeURL</em>).</li>
<li>
<p>If <em>pjson</em> is not <strong>null</strong>, then</p>
<ol>
<li>Return <em>pjson</em>.</li>
</ol>
</li>
<li>Set <em>scopeURL</em> to the parent URL of <em>scopeURL</em>.</li>
</ol>
</li>
<li>Return <strong>null</strong>.</li>
</ol>
</blockquote>
<p><strong>READ_PACKAGE_JSON</strong>(<em>packageURL</em>)</p>
<blockquote>
<ol>
<li>Let <em>pjsonURL</em> be the resolution of <em>"package.json"</em> within <em>packageURL</em>.</li>
<li>
<p>If the file at <em>pjsonURL</em> does not exist, then</p>
<ol>
<li>Return <strong>null</strong>.</li>
</ol>
</li>
<li>
<p>If the file at <em>packageURL</em> does not parse as valid JSON, then</p>
<ol>
<li>Throw an <em>Invalid Package Configuration</em> error.</li>
</ol>
</li>
<li>Return the parsed JSON source of the file at <em>pjsonURL</em>.</li>
</ol>
</blockquote>
</details>
<h3>Customizing ESM specifier resolution algorithm<span><a class="mark" href="#esm_customizing_esm_specifier_resolution_algorithm" id="esm_customizing_esm_specifier_resolution_algorithm">#</a></span></h3>
<p>The current specifier resolution does not support all default behavior of
the CommonJS loader. One of the behavior differences is automatic resolution
of file extensions and the ability to import directories that have an index
file.</p>
<p>The <code>--es-module-specifier-resolution=[mode]</code> flag can be used to customize
the extension resolution algorithm. The default mode is <code>explicit</code>, which
requires the full path to a module be provided to the loader. To enable the
automatic extension resolution and importing from directories that include an
index file use the <code>node</code> mode.</p>
<pre><code class="language-bash">$ node --experimental-modules index.mjs
success!
$ node --experimental-modules index #Failure!
Error: Cannot find module
$ node --experimental-modules --es-module-specifier-resolution=node index
success!
</code></pre>
</div>
</div>
</div>
<script src="assets/sh_main.js"></script>
<script src="assets/sh_javascript.min.js"></script>
<script>highlight(undefined, undefined, 'pre');</script>
</body>
</html>