Skip to content

Commit 55fe340

Browse files
cjihrigBridgeAR
authored andcommitted
doc: improve createRequire() example
Update the example to use import and import.meta.url instead of require() and require.resolve(). PR-URL: #27762 Fixes: #27758 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anto Aravinth <[email protected]>
1 parent 2bc177a commit 55fe340

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

.eslintrc.js

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ module.exports = {
3939
{
4040
files: [
4141
'doc/api/esm.md',
42+
'doc/api/modules.md',
4243
'test/es-module/test-esm-type-flag.js',
4344
'test/es-module/test-esm-type-flag-alias.js',
4445
'*.mjs',

doc/api/modules.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -923,11 +923,11 @@ added: v12.2.0
923923
* Returns: {require} Require function
924924

925925
```js
926-
const { createRequire } = require('module');
927-
const requireUtil = createRequire(require.resolve('../src/utils/'));
926+
import { createRequire } from 'module';
927+
const require = createRequire(import.meta.url);
928928

929-
// Require `../src/utils/some-tool`
930-
requireUtil('./some-tool');
929+
// sibling-module.js is a CommonJS module.
930+
const siblingModule = require('./sibling-module');
931931
```
932932
933933
### module.createRequireFromPath(filename)

0 commit comments

Comments
 (0)