Add Server Timing information to docs #324
Merged
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
rviscomi
reviewed
Mar 1, 2023
README.md
Outdated
| @@ -1018,7 +1018,8 @@ interface FCPAttribution { | |||
| fcpEntry?: PerformancePaintTiming; | |||
| /** | |||
| * The `navigation` entry of the current page, which is useful for diagnosing | |||
| * general page load issues. | |||
| * general page load issues. This can be used to access `serverTiming` for example: | |||
| * navigationEntry.serverTiming | |||
There was a problem hiding this comment.
Does this need to be navigationEntry?.serverTiming everywhere?
There was a problem hiding this comment.
A matter of taste. The OptionalChaining ? operator is only needed if navigationEntry is undefined. But I think in terms of docs here it's fine to exclude it.
It could also we used like this without the ?, for example:
const myServerTiming = navigationEntry ? navigationEntry.serverTiming : '(not set)'There was a problem hiding this comment.
Phil used it in his example code so probably worth sticking with his preference 😛
rviscomi
approved these changes
Mar 1, 2023
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.
Fixes #302
Decided against adding an explicit value for this as, unlike the others, there's no calculation needed, and want to keep the build small. So documented this as an example instead.