Skip to content

Commit 76cdb54

Browse files
patrickhulcepaulirish
authored andcommitted
docs(config): add explanations for gatherers property (#2704)
1 parent 5728695 commit 76cdb54

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Each `passes` entry defines basic settings such as how long to wait for the page
121121
| networkQuietThresholdMs | `number` | The number of milliseconds since the last network request to wait before the page should be considered to have reached 'network quiet'. Used to ensure the page has had time for the full waterfall of network requests to complete before ending a trace. (Default: 5000) |
122122
| pauseAfterNetworkQuietMs | `number` | The number of milliseconds to wait after 'network quiet' before the pass can continue. Used to ensure the page has had time for post-network-quiet JavaScript to execute before ending a trace. (Default: 0) |
123123
| blockedUrlPatterns | `string[]` | URLs of requests to block while loading the page. Basic wildcard support using `*`. |
124-
| gatherers | `string[]` | The list of gatherers to run on this pass. |
124+
| gatherers | `string[]` | The list of gatherers to run on this pass. This property is required and on extension will be concatenated with the existing set of gatherers. |
125125

126126
### `audits: string[]`
127127

lighthouse-core/config/fast-config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,12 @@ module.exports = {
2626
passes: [
2727
{
2828
passName: 'defaultPass',
29+
// overwrite the throttling and load wait parameters
2930
useThrottling: false,
3031
pauseAfterLoadMs: 0,
3132
networkQuietThresholdMs: 500,
3233
cpuQuietThresholdMs: 500,
34+
// no need to add any gatherers yet, but this property is required
3335
gatherers: [],
3436
},
3537
],

0 commit comments

Comments
 (0)