1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: remove "note that" from modules.md

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Rich Trott 2019-06-20 13:41:00 -06:00
parent a3ad22e53f
commit c68513f632
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/modules.md
View File

@ -589,8 +589,8 @@ added: v0.3.0
* {Object} * {Object}
Modules are cached in this object when they are required. By deleting a key Modules are cached in this object when they are required. By deleting a key
value from this object, the next `require` will reload the module. Note that value from this object, the next `require` will reload the module.
this does not apply to [native addons][], for which reloading will result in an This does not apply to [native addons][], for which reloading will result in an
error. error.
Adding or replacing entries is also possible. This cache is checked before Adding or replacing entries is also possible. This cache is checked before
@ -675,7 +675,7 @@ changes:
* `paths` {string[]} Paths to resolve module location from. If present, these * `paths` {string[]} Paths to resolve module location from. If present, these
paths are used instead of the default resolution paths, with the exception paths are used instead of the default resolution paths, with the exception
of [GLOBAL_FOLDERS][] like `$HOME/.node_modules`, which are always of [GLOBAL_FOLDERS][] like `$HOME/.node_modules`, which are always
included. Note that each of these paths is used as a starting point for included. Each of these paths is used as a starting point for
the module resolution algorithm, meaning that the `node_modules` hierarchy the module resolution algorithm, meaning that the `node_modules` hierarchy
is checked from this location. is checked from this location.
* Returns: {string} * Returns: {string}
@ -728,7 +728,7 @@ added: v0.1.16
The `module.exports` object is created by the `Module` system. Sometimes this is The `module.exports` object is created by the `Module` system. Sometimes this is
not acceptable; many want their module to be an instance of some class. To do not acceptable; many want their module to be an instance of some class. To do
this, assign the desired export object to `module.exports`. Note that assigning this, assign the desired export object to `module.exports`. Assigning
the desired object to `exports` will simply rebind the local `exports` variable, the desired object to `exports` will simply rebind the local `exports` variable,
which is probably not what is desired. which is probably not what is desired.
@ -755,7 +755,7 @@ a.on('ready', () => {
}); });
``` ```
Note that assignment to `module.exports` must be done immediately. It cannot be Assignment to `module.exports` must be done immediately. It cannot be
done in any callbacks. This does not work: done in any callbacks. This does not work:
`x.js`: `x.js`:
@ -905,7 +905,7 @@ added: v9.3.0
A list of the names of all modules provided by Node.js. Can be used to verify A list of the names of all modules provided by Node.js. Can be used to verify
if a module is maintained by a third party or not. if a module is maintained by a third party or not.
Note that `module` in this context isn't the same object that's provided `module` in this context isn't the same object that's provided
by the [module wrapper][]. To access it, require the `Module` module: by the [module wrapper][]. To access it, require the `Module` module:
```js ```js