From 58a59a8d6ba2de899dd6093e644ee3cf0d4b9a0a Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sat, 18 May 2019 09:10:20 -0400 Subject: [PATCH] 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 Reviewed-By: Anto Aravinth --- .eslintrc.js | 1 + doc/api/modules.md | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index ff117624f5bd56..55b61cea63be6c 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 9266d43f49abcd..2be27fe6ce12dc 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)