process: add _getActiveHandles documentation #37261
Open
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
nodejs-github-bot
added
doc
Documenting activeHandles documentation in the process API which can be used by the developers to make functions/modules to track the health of their node process.
yashLadha
force-pushed
the
handle_documentation
branch
from
f4167fa to
053b900
Compare
mscdex
suggested changes
Feb 7, 2021
There was a problem hiding this comment.
I think we should instead strive to either remove the "private" underscore prefix or come up with an alternative public API that achieves the same goal. We should not make a habit of documenting private properties/methods, no matter how useful they might seem.
RaisinTen
added a commit
to RaisinTen/node
that referenced
this pull request
Feb 7, 2021
These are made public because it is useful to have as mentioned here: nodejs#37261
RaisinTen
added a commit
to RaisinTen/node
that referenced
this pull request
Feb 7, 2021
These are made public because of the reasons mentioned here: nodejs#37261
|
PR to make it public: #37262 |
RaisinTen
reviewed
Feb 7, 2021
| @@ -2569,6 +2569,17 @@ process has been running. | |||
| The return value includes fractions of a second. Use `Math.floor()` to get whole | |||
| seconds. | |||
|
|
|||
| ## `process._getActiveHandles()` | |||
There was a problem hiding this comment.
Suggested change
| ## `process._getActiveHandles()` | |
| ## `process.getActiveHandles()` |
RaisinTen
reviewed
Feb 7, 2021
|
|
||
| * Returns: {Array} | ||
|
|
||
| The `process.getActiveHandles` method returns the list of handles that are |
There was a problem hiding this comment.
Suggested change
| The `process.getActiveHandles` method returns the list of handles that are | |
| The `process.getActiveHandles()` method returns the list of handles that are |
RaisinTen
reviewed
Feb 7, 2021
Comment on lines
+2580
to
+2581
| currently opened up by the process. These can be open file descriptors, | ||
| conenction, resources that are actively being held by the process. |
There was a problem hiding this comment.
Suggested change
| currently opened up by the process. These can be open file descriptors, | |
| conenction, resources that are actively being held by the process. | |
| currently acquired by the process. These can be open file descriptors, | |
| connections, and resources. |
RaisinTen
added a commit
to RaisinTen/node
that referenced
this pull request
Feb 7, 2021
These are made public because of the reasons mentioned here: nodejs#37261
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.
Documenting activeHandles documentation in the process API which can be
used by the developers to make functions/modules to track the health of
their node process.
Though i am aware of the reason that why it is not documented yet, even though being very
much helpful for instrumentation of process stats. I might be lacking some
information around the context but wanted to float this PR so that iteration can
be done on this PR and developers are aware of this awesome function.