daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documenting `require.main`, fixing #997

pull/22966/head
Trevor Burnham 2011-05-01 14:03:08 -04:00 committed by Ryan Dahl
parent 110f06578d
commit 31ed87b0a9
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/api/modules.markdown
View File

@ -305,6 +305,21 @@ the same process. As the application stack grows, we tend to assemble
functionality, and it is a problem with those parts interact in ways functionality, and it is a problem with those parts interact in ways
that are difficult to predict. that are difficult to predict.
### Accessing the main module
When a file is run directly from Node, `require.main` is set to its
`module`. That means that you can determine whether a file has been run
directly by testing
require.main === module
For a file `foo.js`, this will be `true` if run via `node foo.js`, but
`false` if run by `require('./foo')`.
Because `module` provides a `filename` property (normally equivalent to
`__filename`), the entry point of the current application can be obtained
by checking `require.main.filename`.
## Addenda: Package Manager Tips ## Addenda: Package Manager Tips
The semantics of Node's `require()` function were designed to be general The semantics of Node's `require()` function were designed to be general