Skip to content

doc: clarify relation between a file and a module #9026

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.

Sign up for GitHub

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

Closed
marzelin wants to merge 2 commits into from
Closed

doc: clarify relation between a file and a module #9026

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9472278
doc: clarify relation between a file and a module
marzelin Oct 11, 2016
302de18
doc: remove controversial parts
marzelin Oct 12, 2016
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
Next Next commit
doc: clarify relation between a file and a module 
I've found this sentence: `In Node.js, files and modules are in one-to-one correspondence.` a bit vague, so I propose replacing it with a more informative one.
  • Loading branch information
@marzelin
marzelin authored Oct 11, 2016
commit 9472278a4cfc7ccf4fb132c915b13404185e6abc
3 changes: 1 addition & 2 deletions doc/api/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

<!--name=module-->

Node.js has a simple module loading system. In Node.js, files and modules are
in one-to-one correspondence. As an example, `foo.js` loads the module
Node.js has a simple module loading system. In Node.js each JavaScript file is a separate module which means that all variables, constants, functions, etc. declared in the file can be accessed only in that specific file unless explicitly exposed using `exports`-`require` interface. As an example, `foo.js` loads the module
Copy link
Copy Markdown
Contributor

@cjihrig cjihrig Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Node supports more than just JavaScript source files.

Copy link
Copy Markdown
Contributor Author

@marzelin marzelin Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean json, c++ addons? Are they treated as modules, too?

Copy link
Copy Markdown
Member

@addaleax addaleax Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean json, c++ addons? Are they treated as modules, too?

Yes. :)

Copy link
Copy Markdown
Contributor

@cjihrig cjihrig Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Things can also be exposed outside of a module if they are declared as globals, for example.

Copy link
Copy Markdown
Contributor Author

@marzelin marzelin Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean adding something to global object? global is there but it should be the last resort or never used at all.

Copy link
Copy Markdown
Contributor

@cjihrig cjihrig Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was referring to accidentally creating global variables, but yes, you could do that too. Definitely not something that we want to recommend, but still technically possible.

Copy link
Copy Markdown
Contributor Author

@marzelin marzelin Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

omg Node doesn't use strict mode by default. That changes things a little bit. Current module system doesn't protect from polluting global namespace, but just reads and executes specified files. I hope Node.js will soon support ES2015 modules. Thanks for pointing this out.

`circle.js` in the same directory.

The contents of `foo.js`:
Expand Down