doc: add review suggestions to require()

PR-URL: #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>
nodejs · Oct 12, 2018 · dd5afbe05f1b49c8d5ba2f832f9fd9914d8c1998 · dd5afbe
1 parent 83ddd3e
commit dd5afbe05f1b49c8d5ba2f832f9fd9914d8c1998
Unified Split

Showing with 16 additions and 1 deletion.

+16 −1 doc/api/modules.md
diff --git 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