Skip to content

Commit

Permalink
doc: clarify introductory module material
Browse files Browse the repository at this point in the history
PR-URL: #9816
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Prince John Wesley <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Sam Roberts <[email protected]>
  • Loading branch information
Trott authored and addaleax committed Dec 5, 2016
1 parent 2e22fa0 commit 8c70f79
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@

Node.js has a simple module loading system. In Node.js, files and modules
are in one-to-one correspondence (each file is treated as a separate module).
As an example, `foo.js` loads the module `circle.js` in the same directory.

The contents of `foo.js`:
As an example, consider a file named `foo.js`:

```js
const circle = require('./circle.js');
console.log(`The area of a circle of radius 4 is ${circle.area(4)}`);
```

The contents of `circle.js`:
On the first line, `foo.js` loads the module `circle.js` that is in the same
directory as `foo.js`.

Here are the contents of `circle.js`:

```js
const PI = Math.PI;

exports.area = (r) => PI * r * r;

exports.circumference = (r) => 2 * PI * r;

```

The module `circle.js` has exported the functions `area()` and
Expand Down

0 comments on commit 8c70f79

Please sign in to comment.