mirror of
https://github.com/zebrajr/node.git
synced 2026-01-15 12:15:26 +00:00
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:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user