Add Server Timing information to docs (#324)

* Add Server Timing information to docs * Review feedback
GoogleChrome · Mar 1, 2023 · 39dbf5d · 39dbf5d
1 parent 9f11c4c
commit 39dbf5d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -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
    */
   navigationEntry?: PerformanceNavigationTiming | NavigationTimingPolyfillEntry;
 }
@@ -1129,7 +1130,8 @@ interface LCPAttribution {
   elementRenderDelay: number;
   /**
    * 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
    */
   navigationEntry?: PerformanceNavigationTiming | NavigationTimingPolyfillEntry;
   /**
@@ -1169,8 +1171,9 @@ interface TTFBAttribution {
    */
   requestTime: number;
   /**
-   * The `PerformanceNavigationTiming` entry used to determine TTFB (or the
-   * polyfill entry in browsers that don't support Navigation Timing).
+   * The `navigation` entry of the current page, which is useful for diagnosing
+   * general page load issues. This can be used to access `serverTiming` for example:
+   * navigationEntry?.serverTiming
    */
   navigationEntry?: PerformanceNavigationTiming | NavigationTimingPolyfillEntry;
 }

diff --git a/src/types/fcp.ts b/src/types/fcp.ts
@@ -52,7 +52,8 @@ export 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
    */
   navigationEntry?: PerformanceNavigationTiming | NavigationTimingPolyfillEntry;
 }

diff --git a/src/types/lcp.ts b/src/types/lcp.ts
@@ -66,7 +66,8 @@ export interface LCPAttribution {
   elementRenderDelay: number;
   /**
    * 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
    */
   navigationEntry?: PerformanceNavigationTiming | NavigationTimingPolyfillEntry;
   /**

diff --git a/src/types/ttfb.ts b/src/types/ttfb.ts
@@ -52,8 +52,9 @@ export interface TTFBAttribution {
    */
   requestTime: number;
   /**
-   * The `PerformanceNavigationTiming` entry used to determine TTFB (or the
-   * polyfill entry in browsers that don't support Navigation Timing).
+   * The `navigation` entry of the current page, which is useful for diagnosing
+   * general page load issues. This can be used to access `serverTiming` for example:
+   * navigationEntry?.serverTiming
    */
   navigationEntry?: PerformanceNavigationTiming | NavigationTimingPolyfillEntry;
 }