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

Improve documentation for Performance Hooks entry types #32047

Closed
mmarchini opened this issue Mar 2, 2020 · 4 comments
Closed

Improve documentation for Performance Hooks entry types #32047

mmarchini opened this issue Mar 2, 2020 · 4 comments
Labels
doc Issues and PRs related to the documentations. perf_hooks Issues and PRs related to the implementation of the Performance Timing API.

Comments

@mmarchini
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Performance Hooks entry types gc, http and http2 are only listed in the docs, there's no explanation about when those are triggered or examples how to use them efficiently.

Describe the solution you'd like
Better documentation for those entry types.

Describe alternatives you've considered
Blog posts? But these can easily get outdated (for example, clearGC mentioned here doesn't seem to be on the API anymore).

@addaleax addaleax added doc Issues and PRs related to the documentations. perf_hooks Issues and PRs related to the implementation of the Performance Timing API. labels Mar 2, 2020
@dev-script
Copy link
Contributor

I would like to work on this issue.

@SowmyaGrama
Copy link

@dev-script : Have you started work on this? Do you need another helping hand? I am attempting for first time contribution.

@dev-script
Copy link
Contributor

@SowmyaGrama : Not yet but It would be nice if you help. Thanks

@jasnell
Copy link
Member

jasnell commented Feb 22, 2021

#37136 greatly expands the documentation for these types.

@jasnell jasnell closed this as completed Feb 22, 2021
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. perf_hooks Issues and PRs related to the implementation of the Performance Timing API.
Projects
None yet
Development

No branches or pull requests

5 participants