Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2017-09-10 15:13:47 +0300
committerJames M Snell <jasnell@gmail.com>2017-09-20 19:32:39 +0300
commit38422d59636f3a3bd0d311dcfc7586b7c949e705 (patch)
tree115f19732737318b0c0e742bae8c9184249b9c5e /doc/api/esm.md
parenta32c8a566ef1996d786e49e9bb0e672f5864e5ba (diff)
doc: fix nits in esm.md
* Fix some abbreviated wording, a typo and a link. * Wrap long lines at 80 characters. PR-URL: https://github.com/nodejs/node/pull/15315 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/esm.md')
-rw-r--r--doc/api/esm.md37
1 files changed, 25 insertions, 12 deletions
diff --git a/doc/api/esm.md b/doc/api/esm.md
index 108fd763364..7b684e99a27 100644
--- a/doc/api/esm.md
+++ b/doc/api/esm.md
@@ -6,17 +6,21 @@
<!--name=esm-->
-Node contains support for ES Modules based upon the [the Node EP for ES Modules][].
+Node.js contains support for ES Modules based upon the
+[Node.js EP for ES Modules][].
-Not all features of the EP are complete and will be landing as both VM support and implementation is ready. Error messages are still being polished.
+Not all features of the EP are complete and will be landing as both VM support
+and implementation is ready. Error messages are still being polished.
## Enabling
<!-- type=misc -->
-The `--experimental-modules` flag can be used to enable features for loading ESM modules.
+The `--experimental-modules` flag can be used to enable features for loading
+ESM modules.
-Once this has been set, files ending with `.mjs` will be able to be loaded as ES Modules.
+Once this has been set, files ending with `.mjs` will be able to be loaded
+as ES Modules.
```sh
node --experimental-modules my-app.mjs
@@ -28,7 +32,9 @@ node --experimental-modules my-app.mjs
### Supported
-Only the CLI argument for the main entry point to the program can be an entry point into an ESM graph. In the future `import()` can be used to create entry points into ESM graphs at run time.
+Only the CLI argument for the main entry point to the program can be an entry
+point into an ESM graph. In the future `import()` can be used to create entry
+points into ESM graphs at run time.
### Unsupported
@@ -43,11 +49,13 @@ Only the CLI argument for the main entry point to the program can be an entry po
### No NODE_PATH
-`NODE_PATH` is not part of resolving `import` specifiers. Please use symlinks if this behavior is desired.
+`NODE_PATH` is not part of resolving `import` specifiers. Please use symlinks
+if this behavior is desired.
### No `require.extensions`
-`require.extensions` is not used by `import`. The expectation is that loader hooks can provide this workflow in the future.
+`require.extensions` is not used by `import`. The expectation is that loader
+hooks can provide this workflow in the future.
### No `require.cache`
@@ -55,9 +63,12 @@ Only the CLI argument for the main entry point to the program can be an entry po
### URL based paths
-ESM are resolved and cached based upon [URL](url.spec.whatwg.org) semantics. This means that files containing special characters such as `#` and `?` need to be escaped.
+ESM are resolved and cached based upon [URL](https://url.spec.whatwg.org/)
+semantics. This means that files containing special characters such as `#` and
+`?` need to be escaped.
-Modules will be loaded multiple times if the `import` specifier used to resolve them have a different query or fragment.
+Modules will be loaded multiple times if the `import` specifier used to resolve
+them have a different query or fragment.
```js
import './foo?query=1'; // loads ./foo with query of "?query=1"
@@ -70,9 +81,11 @@ For now, only modules using the `file:` protocol can be loaded.
All CommonJS, JSON, and C++ modules can be used with `import`.
-Modules loaded this way will only be loaded once, even if their query or fragment string differs between `import` statements.
+Modules loaded this way will only be loaded once, even if their query
+or fragment string differs between `import` statements.
-When loaded via `import` these modules will provide a single `default` export representing the value of `module.exports` at the time they finished evaluating.
+When loaded via `import` these modules will provide a single `default` export
+representing the value of `module.exports` at the time they finished evaluating.
```js
import fs from 'fs';
@@ -85,4 +98,4 @@ fs.readFile('./foo.txt', (err, body) => {
});
```
-[the Node EP for ES Modules]: https://github.com/nodejs/node-eps/blob/master/002-es-modules.md
+[Node.js EP for ES Modules]: https://github.com/nodejs/node-eps/blob/master/002-es-modules.md