Skip to content

Commit

Permalink
docs(config): add explanations for gatherers property (#2704)
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickhulce authored and paulirish committed Jul 17, 2017
1 parent 5728695 commit 76cdb54
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Each `passes` entry defines basic settings such as how long to wait for the page
| 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) |
| 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) |
| blockedUrlPatterns | `string[]` | URLs of requests to block while loading the page. Basic wildcard support using `*`. |
| gatherers | `string[]` | The list of gatherers to run on this pass. |
| 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. |

### `audits: string[]`

Expand Down
2 changes: 2 additions & 0 deletions lighthouse-core/config/fast-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ module.exports = {
passes: [
{
passName: 'defaultPass',
// overwrite the throttling and load wait parameters
useThrottling: false,
pauseAfterLoadMs: 0,
networkQuietThresholdMs: 500,
cpuQuietThresholdMs: 500,
// no need to add any gatherers yet, but this property is required
gatherers: [],
},
],
Expand Down

0 comments on commit 76cdb54

Please sign in to comment.