diff options
author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2017-04-05 04:16:56 +0300 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2017-04-08 16:02:01 +0300 |
commit | 166a15669f7a31cba07196d6be4441b8e0a87f31 (patch) | |
tree | 25a03b0c63c2cbad1b9d2488d67bb155c0811df7 /doc/api | |
parent | 96619fc97fbf4667010ecdde61a774b6e62fab18 (diff) | |
download | android-node-v8-166a15669f7a31cba07196d6be4441b8e0a87f31.tar.gz android-node-v8-166a15669f7a31cba07196d6be4441b8e0a87f31.tar.bz2 android-node-v8-166a15669f7a31cba07196d6be4441b8e0a87f31.zip |
doc: modernize and fix code examples in modules.md
* Replace `var` by `const`.
* Fix semicolons.
* Add missing code marks.
* Unify quotes.
* Comment out ellipsis.
* Use object destructuring.
* Use exponentiation operator.
* Replace snake_case by camelCase.
PR-URL: https://github.com/nodejs/node/pull/12224
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/modules.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/api/modules.md b/doc/api/modules.md index 397964c251..65f57314cc 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -20,9 +20,9 @@ directory as `foo.js`. Here are the contents of `circle.js`: ```js -const PI = Math.PI; +const { PI } = Math; -exports.area = (r) => PI * r * r; +exports.area = (r) => PI * r ** 2; exports.circumference = (r) => 2 * PI * r; ``` @@ -44,7 +44,7 @@ Below, `bar.js` makes use of the `square` module, which exports a constructor: ```js const square = require('./square.js'); -var mySquare = square(2); +const mySquare = square(2); console.log(`The area of my square is ${mySquare.area()}`); ``` @@ -54,12 +54,12 @@ The `square` module is defined in `square.js`: // assigning to exports will not modify module, must use module.exports module.exports = (width) => { return { - area: () => width * width + area: () => width ** 2 }; -} +}; ``` -The module system is implemented in the `require("module")` module. +The module system is implemented in the `require('module')` module. ## Accessing the main module @@ -142,7 +142,7 @@ To get the exact filename that will be loaded when `require()` is called, use the `require.resolve()` function. Putting together all of the above, here is the high-level algorithm -in pseudocode of what require.resolve does: +in pseudocode of what `require.resolve()` does: ```txt require(X) from module at path Y @@ -565,16 +565,16 @@ To illustrate the behavior, imagine this hypothetical implementation of `require()`, which is quite similar to what is actually done by `require()`: ```js -function require(...) { - var module = { exports: {} }; +function require(/* ... */) { + const module = { exports: {} }; ((module, exports) => { // Your module code here. In this example, define a function. - function some_func() {}; - exports = some_func; + function someFunc() {} + exports = someFunc; // At this point, exports is no longer a shortcut to module.exports, and // this module will still export an empty default object. - module.exports = some_func; - // At this point, the module will now export some_func, instead of the + module.exports = someFunc; + // At this point, the module will now export someFunc, instead of the // default object. })(module, module.exports); return module.exports; |