diff --git a/doc/api/modules.md b/doc/api/modules.md index 5653fe8f4245bd..9dc5cd22248dc0 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -132,7 +132,7 @@ variable. Since the module lookups using `node_modules` folders are all relative, and based on the real path of the files making the calls to `require()`, the packages themselves can be anywhere. -## Addenda: The .mjs extension +## Addenda: The `.mjs` extension It is not possible to `require()` files that have the `.mjs` extension. Attempting to do so will throw [an error][]. The `.mjs` extension is @@ -518,7 +518,7 @@ the module rather than the global object. ## The module scope -### \_\_dirname +### `__dirname` @@ -539,7 +539,7 @@ console.log(path.dirname(__filename)); // Prints: /Users/mjr ``` -### \_\_filename +### `__filename` @@ -577,7 +577,7 @@ References to `__filename` within `b.js` will return `/Users/mjr/app/node_modules/b/b.js` while references to `__filename` within `a.js` will return `/Users/mjr/app/a.js`. -### exports +### `exports` @@ -590,7 +590,7 @@ A reference to the `module.exports` that is shorter to type. See the section about the [exports shortcut][] for details on when to use `exports` and when to use `module.exports`. -### module +### `module` @@ -603,7 +603,7 @@ A reference to the current module, see the section about the [`module` object][]. In particular, `module.exports` is used for defining what a module exports and makes available through `require()`. -### require(id) +### `require(id)` @@ -630,7 +630,7 @@ const jsonData = require('./path/filename.json'); const crypto = require('crypto'); ``` -#### require.cache +#### `require.cache` @@ -647,7 +647,7 @@ native modules and if a name matching a native module is added to the cache, no require call is going to receive the native module anymore. Use with care! -#### require.extensions +#### `require.extensions` @@ -710,7 +710,7 @@ Module { '/node_modules' ] } ``` -#### require.resolve(request\[, options\]) +#### `require.resolve(request[, options])` @@ -759,7 +759,7 @@ representing the current module. For convenience, `module.exports` is also accessible via the `exports` module-global. `module` is not actually a global but rather local to each module. -### module.children +### `module.children` @@ -768,7 +768,7 @@ added: v0.1.16 The module objects required for the first time by this one. -### module.exports +### `module.exports` @@ -822,7 +822,7 @@ const x = require('./x'); console.log(x.a); ``` -#### exports shortcut +#### `exports` shortcut @@ -869,7 +869,7 @@ function require(/* ... */) { } ``` -### module.filename +### `module.filename` @@ -878,7 +878,7 @@ added: v0.1.16 The fully resolved filename of the module. -### module.id +### `module.id` @@ -888,7 +888,7 @@ added: v0.1.16 The identifier for the module. Typically this is the fully resolved filename. -### module.loaded +### `module.loaded` @@ -898,7 +898,7 @@ added: v0.1.16 Whether or not the module is done loading, or is in the process of loading. -### module.parent +### `module.parent` @@ -907,7 +907,7 @@ added: v0.1.16 The module that first required this one. -### module.paths +### `module.paths` @@ -916,7 +916,7 @@ added: v0.4.0 The search paths for the module. -### module.require(id) +### `module.require(id)` @@ -944,7 +944,7 @@ Provides general utility methods when interacting with instances of `Module` — the `module` variable often seen in file modules. Accessed via `require('module')`. -### module.builtinModules +### `module.builtinModules` @@ -982,7 +982,7 @@ const require = createRequire(import.meta.url); const siblingModule = require('./sibling-module'); ``` -### module.createRequireFromPath(filename) +### `module.createRequireFromPath(filename)`