Skip to content

Commit 04a81b3

Browse files
aduh95danielleadams
authored andcommitted
doc: document that require.main may be undefined
PR-URL: #41384 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Adrian Estrada <edsadr@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
1 parent 71bc352 commit 04a81b3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/api/modules.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,8 @@ run directly by testing `require.main === module`.
7474
For a file `foo.js`, this will be `true` if run via `node foo.js`, but
7575
`false` if run by `require('./foo')`.
7676

77-
Because `module` provides a `filename` property (normally equivalent to
78-
`__filename`), the entry point of the current application can be obtained
79-
by checking `require.main.filename`.
77+
When the entry point is not a CommonJS module, `require.main` is `undefined`,
78+
and the main module is out of reach.
8079

8180
## Package manager tips
8281

@@ -716,10 +715,11 @@ extensions gets slower with each registered extension.
716715
added: v0.1.17
717716
-->
718717

719-
* {module}
718+
* {module | undefined}
720719

721720
The `Module` object representing the entry script loaded when the Node.js
722-
process launched.
721+
process launched, or `undefined` if the entry point of the program is not a
722+
CommonJS module.
723723
See ["Accessing the main module"](#accessing-the-main-module).
724724

725725
In `entry.js` script:

0 commit comments

Comments
 (0)