doc: add require.main to require properties
#19573
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vsemozhetbyt
added
the
fast-track
nodejs-github-bot
added
doc
targos
reviewed
Mar 24, 2018
doc/api/modules.md
Outdated
| @@ -600,6 +600,16 @@ filename scales linearly with the number of registered extensions. | |||
| In other words, adding extensions slows down the module loader and | |||
| should be discouraged. | |||
|
|
|||
| #### require.main | |||
| <!-- YAML | |||
| added: ??? | |||
There was a problem hiding this comment.
Looks like it was added in 1020efb.
That means v0.1.17
There was a problem hiding this comment.
Thank you! Updating...
lpinca
approved these changes
Mar 24, 2018
jasnell
reviewed
Mar 24, 2018
doc/api/modules.md
Outdated
|
|
||
| * {Object} | ||
|
|
||
| The main module of the entry script. |
There was a problem hiding this comment.
The description isn't overly useful. Perhaps something like...
The `Module` object representing the entry script loaded when
the Node.js process launched.
Then include a quick example:
$ node entry.jsconsole.log(reqiure.main)
// Prints
// Module {
// id: '.',
// exports: {},
// parent: null,
// filename: '/absolute/path/to/entry.js',
// loaded: false,
// children: [],
// paths:
// [ '/absolute/path/to/node_modules',
// '/absolute/path/node_modules',
// '/absolute/node_modules',
// '/node_modules' ] }
jasnell
approved these changes
Mar 24, 2018
targos
approved these changes
Mar 24, 2018
`require.main` was documented in a non-standard way. With this PR, the previous section is left as is to not break all the possible link references inside and outside Node.js docs. A standard section is added to the `require` properties with a reference to the old description.
|
Removed CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/313/ |
|
Landed in 610dd79 |
vsemozhetbyt
added a commit
that referenced
this pull request
Mar 24, 2018
`require.main` was documented in a non-standard way. With this PR, the previous section is left as is to not break all the possible link references inside and outside Node.js docs. A standard section is added to the `require` properties with a reference to the old description. PR-URL: #19573 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
targos
pushed a commit
that referenced
this pull request
Mar 27, 2018
`require.main` was documented in a non-standard way. With this PR, the previous section is left as is to not break all the possible link references inside and outside Node.js docs. A standard section is added to the `require` properties with a reference to the old description. PR-URL: #19573 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesrequire.mainwas documented in a non-standard way.With this PR, the previous section is left as is to not break all the possible link references inside and outside Node.js docs.
A standard section is added to the
requireproperties with a reference to the remaining description.I cannot define when this property was added. I can only dig up to this mention of a fix in the 0.3.8. Can anybody help with(see #19573 (comment))added:attribution?