diff options
| author | Bradley Farias <bradley.meck@gmail.com> | 2020-09-30 15:57:08 -0500 |
|---|---|---|
| committer | Myles Borins <mylesborins@github.com> | 2020-11-16 11:57:56 -0500 |
| commit | 42c0dfcc234a75f1ce5a9405c531c012ac3d85f6 (patch) | |
| tree | 49c250b79d98f15dd204ba12621c78281cfea17e /doc | |
| parent | c192af66e7e8c98f86c567a8bef7a5eaf00ec47b (diff) | |
| download | node-new-42c0dfcc234a75f1ce5a9405c531c012ac3d85f6.tar.gz | |
doc: importable node protocol URLs
PR-URL: https://github.com/nodejs/node/pull/35434
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/esm.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/api/esm.md b/doc/api/esm.md index 320f94482e..ed4e6482bf 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -125,13 +125,27 @@ There are four types of specifiers: Bare specifiers, and the bare specifier portion of deep import specifiers, are strings; but everything else in a specifier is a URL. -Only `file:` and `data:` URLs are supported. A specifier like +`file:`, `node:`, and `data:` URLs are supported. A specifier like `'https://example.com/app.js'` may be supported by browsers but it is not supported in Node.js. Specifiers may not begin with `/` or `//`. These are reserved for potential future use. The root of the current volume may be referenced via `file:///`. +#### `node:` Imports + +<!-- YAML +added: REPLACEME +--> + +`node:` URLs are supported as a means to load Node.js builtin modules. This +URL scheme allows for builtin modules to be referenced by valid absolute URL +strings. + +```js +import fs from 'node:fs/promises'; +``` + #### `data:` Imports <!-- YAML |