Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(v6.x backport) doc: modernize and fix code examples in modules.md #12500

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions doc/api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ 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;

Expand All @@ -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()}`);
```

Expand All @@ -56,10 +56,10 @@ module.exports = (width) => {
return {
area: () => width * width
};
}
};
```

The module system is implemented in the `require("module")` module.
The module system is implemented in the `require('module')` module.

## Accessing the main module

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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;
Expand Down