Skip to content

Commit

Permalink
docs: fixed scanner.device type + more info (#160)
Browse files Browse the repository at this point in the history
  • Loading branch information
mountainash committed Sep 14, 2023
1 parent 0c8ad7b commit 41073f0
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/content/3.api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ Optional basic auth credentials.

Provide cookies to be set for Axios and Puppeteer requests.


### extraHeaders

- **Type:** ` false | Record<string, string>`
Expand Down Expand Up @@ -324,10 +323,10 @@ Note: If you have `robotsTxt` enabled it will load sitemap config from here.

### scanner.device

- **Type:** `boolean`
- **Type:** `boolean | string`
- **Default:** `mobile`

Alias to switch the device used for scanning. Set to false if you want to manually configure it.
Alias to switch the viewport dimentions used for scanning. Set to `desktop` for a viewport of 1350×950. Set to `false` if you want to manually configure it through `lighthouseOptions.formFactor`.

See [Switching between mobile and desktop](/guide/guides/device#alias-enable-disable-throttling) for more information.

Expand Down

0 comments on commit 41073f0

Please sign in to comment.