doc: process: Document process.mainModule

Instrumentation code might need to find out the entry point of the
process in a global context.
Documenting the existing process.mainModule to officially support this.

Fixes #7808

Signed-off-by: Fedor Indutny <fedor@indutny.com>
This commit is contained in:
Jan Krems 2014-06-21 17:09:04 -07:00 committed by Fedor Indutny
parent fcbffa71d0
commit ad5e8ec3e2
1 changed files with 12 additions and 0 deletions

View File

@ -716,4 +716,16 @@ a diff reading, useful for benchmarks and measuring intervals:
// benchmark took 1000000527 nanoseconds
}, 1000);
## process.mainModule
Alternate way to retrieve
[`require.main`](modules.html#modules_accessing_the_main_module).
The difference is that if the main module changes at runtime, `require.main`
might still refer to the original main module in modules that were required
before the change occurred. Generally it's safe to assume that the two refer
to the same module.
As with `require.main`, it will be `undefined` if there was no entry script.
[EventEmitter]: events.html#events_class_events_eventemitter