diff options
author | cjihrig <cjihrig@gmail.com> | 2019-05-18 09:17:53 -0400 |
---|---|---|
committer | cjihrig <cjihrig@gmail.com> | 2019-05-20 10:22:56 -0400 |
commit | 1b381d630a3a595405c00892c58335369a368915 (patch) | |
tree | cf8792d15bc994b7f2b9b62bfd38f55c6d9f5933 /doc | |
parent | 58a59a8d6ba2de899dd6093e644ee3cf0d4b9a0a (diff) | |
download | android-node-v8-1b381d630a3a595405c00892c58335369a368915.tar.gz android-node-v8-1b381d630a3a595405c00892c58335369a368915.tar.bz2 android-node-v8-1b381d630a3a595405c00892c58335369a368915.zip |
doc: replace createRequireFromPath() references
This commit replaces createRequireFromPath() references with
createRequire() references.
PR-URL: https://github.com/nodejs/node/pull/27762
Fixes: https://github.com/nodejs/node/issues/27758
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/esm.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/esm.md b/doc/api/esm.md index 60f9f6787d..646e7d5e99 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -277,8 +277,7 @@ if this behavior is desired. These CommonJS variables are not available in ES modules. -`require` can be imported into an ES module using -[`module.createRequireFromPath()`][]. +`require` can be imported into an ES module using [`module.createRequire()`][]. An equivalent for `__filename` and `__dirname` is [`import.meta.url`][]. @@ -313,7 +312,7 @@ For now, only modules using the `file:` protocol can be loaded. `require` always treats the files it references as CommonJS. This applies whether `require` is used the traditional way within a CommonJS environment, or -in an ES module environment using [`module.createRequireFromPath()`][]. +in an ES module environment using [`module.createRequire()`][]. To include an ES module into CommonJS, use [`import()`][]. @@ -321,7 +320,7 @@ To include an ES module into CommonJS, use [`import()`][]. An `import` statement can reference either ES module or CommonJS JavaScript. Other file types such as JSON and Native modules are not supported. For those, -use [`module.createRequireFromPath()`][]. +use [`module.createRequire()`][]. `import` statements are permitted only in ES modules. For similar functionality in CommonJS, see [`import()`][]. @@ -362,14 +361,15 @@ to include ES module files from CommonJS code. ## CommonJS, JSON, and Native Modules -CommonJS, JSON, and Native modules can be used with [`module.createRequireFromPath()`][]. +CommonJS, JSON, and Native modules can be used with +[`module.createRequire()`][]. ```js // cjs.js module.exports = 'cjs'; // esm.mjs -import { createRequireFromPath as createRequire } from 'module'; +import { createRequire } from 'module'; import { fileURLToPath as fromURL } from 'url'; const require = createRequire(fromURL(import.meta.url)); @@ -759,7 +759,7 @@ success! [`import`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import [`import()`]: #esm_import-expressions [`import.meta.url`]: #esm_import_meta -[`module.createRequireFromPath()`]: modules.html#modules_module_createrequirefrompath_filename +[`module.createRequire()`]: modules.html#modules_module_createrequire_filename [CommonJS]: modules.html [ECMAScript-modules implementation]: https://github.com/nodejs/modules/blob/master/doc/plan-for-new-modules-implementation.md [Node.js EP for ES Modules]: https://github.com/nodejs/node-eps/blob/master/002-es-modules.md |