Connect & Get help from fellow developers on our Discord community.
Ask the Community
Parameter | Type | Mandatory/Optional | Description | Example |
---|---|---|---|---|
lhConfig | object | Optional | Allows you to pass Lighthouse-specific configurations | βlhConfigβ:{ |
extends: βlighthouse:defaultβ, } | Β | Β | Β | Β |
formFactor | string | Optional | Allows you to include or exclude mobile-specific audits for performance metrics. Possible values for the argument: mobile (default), desktop
|
βformFactorβ: βmobileβ |
screenEmulation | object | Optional | Allows you to set the screen emulation parameters | βscreenEmulationβ: { } |
mobile | boolean | Optional | Allows you to apply overlay scrollbars and other mobile-specific screen emulation | βmobileβ: true |
width | integer | Optional | Allows you to set the width of the screen | βwidthβ: 412 |
height | integer | Optional | Allows you to set the height of the screen | βheightβ: 823 |
deviceScaleFactor | float | Optional | Allows you to set the device scale factor | βdeviceScaleFactorβ: 1.75 |
disabled | boolean | Optional | Allows you to disable the emulation | βdisabledβ: false |
emulatedUserAgent | string | Optional | Allows you to pass you agent value | βemulatedUserAgentβ: βMozilla/5.0 (Linux; Android 11; moto g power (2022)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Mobile Safari/537.36β |
throttlingMethod | string | Optional | Allows you to enable or disable throttling. Valid values for the argument: simulate (default), provided (this disables the lighthouse default throttling) |
βthrottlingMethodβ: βsimulateβ |
throttling | string | Optional | Allows you to set predefined throttling parameters. Possible values for the argument: mobileSlow4G (default), mobileRegular3G , desktopDense4G
|
βthrottlingβ: βmobileRegular3Gβ |
lhConfig.throttling | object | Optional | Allows you to set custom throttling parameters | Β |
rttMs | integer | Optional | Represents the round-trip time in milliseconds | βrttMsβ: 150 |
throughputKbps | float | Optional | Represents the throughput in kilobits per second | βthroughputKbpsβ: 1638.4 |
requestLatencyMs | float | Optional | Represents the request latency in milliseconds | βrequestLatencyMsβ: 562.5 |
downloadThroughputKbps | float | Optional | Represents the download throughput in kilobits per second | βdownloadThroughputKbpsβ: 1474.5600000000002 |
uploadThroughputKbps | float | Optional | Represents the upload throughput in kilobits per second | βuploadThroughputKbpsβ: 675 |
cpuSlowdownMultiplier | integer | Optional | Represents the CPU slowdown multiplier | βcpuSlowdownMultiplierβ: 4 |
executorOutput | string | Optional | Allows you to get the Lighthouse report as a JSON response from the JavaScript executor | βexecutorOutputβ: βjsonβ |
sessionFail | boolean | Optional | Allows you to mark the test session βfailedβ | βassertResultβ: {βsessionFailβ: true} |
onlyCategories | array | Optional | Allows you to run specified categories | βlhConfigβ:{ |
extends: βlighthouse:defaultβ,βonlyCategoriesβ:[]} | Β | Β | Β | Β |
onlyAudits | array | Optional | Allows you to run specified audits | βlhConfigβ:{ |
extends: βlighthouse:defaultβ,βonlyAuditsβ:[]} | Β | Β | Β | Β |
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
- RESOURCES
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!