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

Document async_hooks types purposes #511

Closed
RafaelGSS opened this issue Nov 5, 2021 · 3 comments
Closed

Document async_hooks types purposes #511

RafaelGSS opened this issue Nov 5, 2021 · 3 comments

Comments

@RafaelGSS
Copy link
Member

I'm working on a profiler tool that uses async_hooks to trace events, however, I'm a bit lost to understand the reason for each type of resource.

In the documentation, we have the list of types: https://nodejs.org/api/async_hooks.html#type but there is no description of each event.

Not sure where I should open this issue, if you think that it's more suitable at the node repository feel free to move.

@RafaelGSS
Copy link
Member Author

Currently, there are 2 suggestions:

  • Generate the types of documentation based on the definition (we aren't sure if we want to it)
  • Improve the documentation
    • Update the documentation to explicitly says to not rely too much on the types, because it might change arbitrarily.

@tony-go
Copy link
Member

tony-go commented Jan 29, 2022

Hi @RafaelGSS 👋

Do you plan to raise a pull request for the second point?

I can do it otherwise :) Let me know ^^

@RafaelGSS
Copy link
Member Author

Go ahead :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants