diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-05-18 09:10:20 -0400 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-05-20 10:22:44 -0400 |
| commit | 58a59a8d6ba2de899dd6093e644ee3cf0d4b9a0a (patch) | |
| tree | 83a06a884002469306ba915c3be77279865c8801 | |
| parent | 64182e95e2e156a9b1ad7295b9657f2f69002cd1 (diff) | |
| download | android-node-v8-58a59a8d6ba2de899dd6093e644ee3cf0d4b9a0a.tar.gz android-node-v8-58a59a8d6ba2de899dd6093e644ee3cf0d4b9a0a.tar.bz2 android-node-v8-58a59a8d6ba2de899dd6093e644ee3cf0d4b9a0a.zip | |
doc: improve createRequire() example
Update the example to use import and import.meta.url instead
of require() and require.resolve().
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>
| -rw-r--r-- | .eslintrc.js | 1 | ||||
| -rw-r--r-- | doc/api/modules.md | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/.eslintrc.js b/.eslintrc.js index ff117624f5..55b61cea63 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -39,6 +39,7 @@ module.exports = { { files: [ 'doc/api/esm.md', + 'doc/api/modules.md', 'test/es-module/test-esm-type-flag.js', 'test/es-module/test-esm-type-flag-alias.js', '*.mjs', diff --git a/doc/api/modules.md b/doc/api/modules.md index 9266d43f49..2be27fe6ce 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -923,11 +923,11 @@ added: v12.2.0 * Returns: {require} Require function ```js -const { createRequire } = require('module'); -const requireUtil = createRequire(require.resolve('../src/utils/')); +import { createRequire } from 'module'; +const require = createRequire(import.meta.url); -// Require `../src/utils/some-tool` -requireUtil('./some-tool'); +// sibling-module.js is a CommonJS module. +const siblingModule = require('./sibling-module'); ``` ### module.createRequireFromPath(filename) |