hanzoai/puppeteer
2
0
Fork 0
mirror of https://github.com/hanzoai/puppeteer.git synced 2026-09-24 17:02:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: document units in page.metrics() (#15221)

Browse Source
This commit is contained in:
monkey
2026-07-27 15:38:56 +02:00
committed by GitHub
parent 42b22381d2
commit d371de3983
3 changed files with 83 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/puppeteer.metrics.md
+26
View File
@@ -47,6 +47,8 @@ number
</td><td>
Number of documents in the page.
</td><td>
</td></tr>
@@ -64,6 +66,8 @@ number
</td><td>
Number of frames in the page.
</td><td>
</td></tr>
@@ -81,6 +85,8 @@ number
</td><td>
Number of events in the page.
</td><td>
</td></tr>
@@ -98,6 +104,8 @@ number
</td><td>
Total JavaScript heap size, in bytes.
</td><td>
</td></tr>
@@ -115,6 +123,8 @@ number
</td><td>
Used JavaScript heap size, in bytes.
</td><td>
</td></tr>
@@ -132,6 +142,8 @@ number
</td><td>
Total number of full or partial page layouts.
</td><td>
</td></tr>
@@ -149,6 +161,8 @@ number
</td><td>
Combined duration of all page layouts, in seconds.
</td><td>
</td></tr>
@@ -166,6 +180,8 @@ number
</td><td>
Number of DOM nodes in the page.
</td><td>
</td></tr>
@@ -183,6 +199,8 @@ number
</td><td>
Total number of page style recalculations.
</td><td>
</td></tr>
@@ -200,6 +218,8 @@ number
</td><td>
Combined duration of all page style recalculations, in seconds.
</td><td>
</td></tr>
@@ -217,6 +237,8 @@ number
</td><td>
Combined duration of JavaScript execution, in seconds.
</td><td>
</td></tr>
@@ -234,6 +256,8 @@ number
</td><td>
Combined duration of all tasks performed by the browser, in seconds.
</td><td>
</td></tr>
@@ -251,6 +275,8 @@ number
</td><td>
The timestamp when the metrics sample was taken, in monotonic time (seconds since an arbitrary point in the past).
</td><td>
</td></tr>
docs/api/puppeteer.page.metrics.md
+7 -7
View File
@@ -18,7 +18,7 @@ class Page {
Promise&lt;[Metrics](./puppeteer.metrics.md)&gt;
- `Timestamp` : The timestamp when the metrics sample was taken.
- `Timestamp` : The timestamp when the metrics sample was taken, in monotonic time (seconds).
- `Documents` : Number of documents in the page.
@@ -32,17 +32,17 @@ Promise&lt;[Metrics](./puppeteer.metrics.md)&gt;
- `RecalcStyleCount` : Total number of page style recalculations.
- `LayoutDuration` : Combined durations of all page layouts.
- `LayoutDuration` : Combined durations of all page layouts, in seconds.
- `RecalcStyleDuration` : Combined duration of all page style recalculations.
- `RecalcStyleDuration` : Combined duration of all page style recalculations, in seconds.
- `ScriptDuration` : Combined duration of JavaScript execution.
- `ScriptDuration` : Combined duration of JavaScript execution, in seconds.
- `TaskDuration` : Combined duration of all tasks performed by the browser.
- `TaskDuration` : Combined duration of all tasks performed by the browser, in seconds.
- `JSHeapUsedSize` : Used JavaScript heap size.
- `JSHeapUsedSize` : Used JavaScript heap size, in bytes.
- `JSHeapTotalSize` : Total JavaScript heap size.
- `JSHeapTotalSize` : Total JavaScript heap size, in bytes.
## Remarks
packages/puppeteer-core/src/api/Page.ts
+50 -7
View File
@@ -125,18 +125,58 @@ import type {WebWorker} from './WebWorker.js';
* @public
*/
export interface Metrics {
/**
* The timestamp when the metrics sample was taken, in monotonic time
* (seconds since an arbitrary point in the past).
*/
Timestamp?: number;
/**
* Number of documents in the page.
*/
Documents?: number;
/**
* Number of frames in the page.
*/
Frames?: number;
/**
* Number of events in the page.
*/
JSEventListeners?: number;
/**
* Number of DOM nodes in the page.
*/
Nodes?: number;
/**
* Total number of full or partial page layouts.
*/
LayoutCount?: number;
/**
* Total number of page style recalculations.
*/
RecalcStyleCount?: number;
/**
* Combined duration of all page layouts, in seconds.
*/
LayoutDuration?: number;
/**
* Combined duration of all page style recalculations, in seconds.
*/
RecalcStyleDuration?: number;
/**
* Combined duration of JavaScript execution, in seconds.
*/
ScriptDuration?: number;
/**
* Combined duration of all tasks performed by the browser, in seconds.
*/
TaskDuration?: number;
/**
* Used JavaScript heap size, in bytes.
*/
JSHeapUsedSize?: number;
/**
* Total JavaScript heap size, in bytes.
*/
JSHeapTotalSize?: number;
}
@@ -1720,7 +1760,8 @@ export abstract class Page extends EventEmitter<PageEvents> {
*
* @returns
*
* - `Timestamp` : The timestamp when the metrics sample was taken.
* - `Timestamp` : The timestamp when the metrics sample was taken, in
* monotonic time (seconds).
*
* - `Documents` : Number of documents in the page.
*
@@ -1734,18 +1775,20 @@ export abstract class Page extends EventEmitter<PageEvents> {
*
* - `RecalcStyleCount` : Total number of page style recalculations.
*
* - `LayoutDuration` : Combined durations of all page layouts.
* - `LayoutDuration` : Combined durations of all page layouts, in seconds.
*
* - `RecalcStyleDuration` : Combined duration of all page style
* recalculations.
* recalculations, in seconds.
*
* - `ScriptDuration` : Combined duration of JavaScript execution.
* - `ScriptDuration` : Combined duration of JavaScript execution, in
* seconds.
*
* - `TaskDuration` : Combined duration of all tasks performed by the browser.
* - `TaskDuration` : Combined duration of all tasks performed by the
* browser, in seconds.
*
* - `JSHeapUsedSize` : Used JavaScript heap size.
* - `JSHeapUsedSize` : Used JavaScript heap size, in bytes.
*
* - `JSHeapTotalSize` : Total JavaScript heap size.
* - `JSHeapTotalSize` : Total JavaScript heap size, in bytes.
*
* @remarks
* All timestamps are in monotonic time: monotonically increasing time