Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorerickwendel <erick.workspace@gmail.com>2018-10-12 21:33:59 +0300
committerMyles Borins <mylesborins@google.com>2018-11-29 19:39:09 +0300
commitace83a24a2f18f5b17685f0f82c528bef5d7ae3f (patch)
tree5072e097af160c548bed44532afea8b4b802a8d9 /doc
parenta97e79ce12689fe0f1680c6319547ce8d92083d7 (diff)
doc: add review suggestions to require()
PR-URL: https://github.com/nodejs/node/pull/23605 Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/modules.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/api/modules.md b/doc/api/modules.md
index 59c589e83ac..2475fa2755e 100644
--- a/doc/api/modules.md
+++ b/doc/api/modules.md
@@ -552,7 +552,22 @@ added: v0.1.13
* {Function}
-To require modules.
+Used to import modules, `JSON`, and local files. Modules can be imported
+from `node_modules`. Local modules and JSON files can be imported using
+a relative path (e.g. `./`, `./foo`, `./bar/baz`, `../foo`) that will be
+resolved against the directory named by [`__dirname`][] (if defined) or
+the current working directory.
+
+```js
+// Importing a local module:
+const myLocalModule = require('./path/myLocalModule');
+
+// Importing a JSON file:
+const jsonData = require('./path/filename.json');
+
+// Importing a module from node_modules or Node.js built-in module:
+const crypto = require('crypto');
+```
#### require.cache
<!-- YAML