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: fix property name 'detail' of performanceEntry #40019

Closed
wants to merge 1 commit into from
Closed

doc: fix property name 'detail' of performanceEntry #40019

wants to merge 1 commit into from

Conversation

ChristianBoehlke
Copy link
Contributor

Hello,

I noticed that the performanceEntry that is passed to the callback of PerformanceObserver does not have a property details but it does have a property detail (without the "s"). This is also in line with the deprecation warning and what I could find in the source code:

get detail() { return this[kDetail]; }

detail: this.detail,

'Please use the detail property.';

In case this is correct: I have changed the documentation accordingly. Please let me know if I can do anything else.

Thank you!

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. perf_hooks Issues and PRs related to the implementation of the Performance Timing API. labels Sep 6, 2021
@targos targos added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 6, 2021
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contribution, @ChristianBoehlke!

@targos targos added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 8, 2021
@github-actions github-actions bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 8, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2021

Landed in 9f7412a...6e9a54c

@github-actions github-actions bot closed this Sep 8, 2021
nodejs-github-bot pushed a commit that referenced this pull request Sep 8, 2021
PR-URL: #40019
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@ChristianBoehlke ChristianBoehlke deleted the perf-hooks-details branch September 8, 2021 23:38
cafca added a commit to cafca/DefinitelyTyped that referenced this pull request Sep 12, 2021
This spelling mistake in a property name has been fixed in node.js per nodejs/node#40019
typescript-bot pushed a commit to DefinitelyTyped/DefinitelyTyped that referenced this pull request Sep 19, 2021
…cafca

* Fix property 'detail' of PerformanceEntry

This spelling mistake in a property name has been fixed in node.js per nodejs/node#40019

* Add missing comma

* Fix 'detail' property name in perf_hooks test
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
PR-URL: #40019
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@BethGriggs BethGriggs mentioned this pull request Sep 21, 2021
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. 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

Successfully merging this pull request may close these issues.

6 participants