Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: acknowledge process._getActiveHandles() and process._getActiveRequests() #36036

Closed
exx8 opened this issue Nov 8, 2020 · 4 comments
Closed
Labels
doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem.

Comments

@exx8
Copy link

exx8 commented Nov 8, 2020

📗 API Reference Docs Problem

  • Version: node>=15
  • Platform: all platforms
  • Subsystem: process

Location

Section of the site where the content exists

Affected URL(s):

Description

Concise explanation of the problem

I believe the functions process._getActiveHandles() and process._getActiveRequests() should be documented, and be acknowledged; We should consider adding non-dashed alias as it is used for some time in the ecosystem.
Currently there are packages which rely at those methods. Even if they will be considered for removal, a regular deprecation process should be considered.
Alternatively, a consensual interface should be considered, if there is a reason for which, the functions aren't documented.
Anyway, as the functionality is in use and appears time to time in the community, we should embrace these functionalities, as part of the standard documented node features.


  • [ ?] I would like to work on this issue and
    submit a pull request.

? question mark stands for "it depends".

@exx8 exx8 added the doc Issues and PRs related to the documentations. label Nov 8, 2020
@mscdex
Copy link
Contributor

mscdex commented Nov 8, 2020

@exx8
Copy link
Author

exx8 commented Nov 8, 2020

It seems that it has been stalled, would you like me to consider to pick it up?
As far I can understand, it's only ref change, and adding docs isn't it?

@targos targos added the process Issues and PRs related to the process subsystem. label Aug 9, 2021
@NutriMarc
Copy link

I would love to have some help from documentation on how I can see what is in the event loop. Can someone pick this up so a lowly programmer like me can better understand and debug concurrency issues that currently seem more like black magic than science to me?

@bnoordhuis
Copy link
Member

Someone would need to revive one of the earlier attempts and resolve the outstanding issues.

Speaking for myself (but also as the one who introduced those methods), I don't think they're all that useful actually to most users. There is no 1-to-1 correspondence between libuv handles and JS objects.

I'm going to close this issue because it's approaching its three year anniversary without movement but a PR is still welcome, just don't expect it to get merged without additional discussion.

@bnoordhuis bnoordhuis closed this as not planned Won't fix, can't repro, duplicate, stale Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem.
Projects
None yet
Development

No branches or pull requests

5 participants