From ad5e8ec3e2845d8d048ac8160f6af0194bc2b7e9 Mon Sep 17 00:00:00 2001 From: Jan Krems Date: Sat, 21 Jun 2014 17:09:04 -0700 Subject: [PATCH] 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 --- doc/api/process.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/api/process.markdown b/doc/api/process.markdown index eac1d4e..8c914f3 100644 --- a/doc/api/process.markdown +++ b/doc/api/process.markdown @@ -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 -- 2.7.4