puppeteer/new-docs/puppeteer.puppeteer.devices.md
Jack Franklin 6ee7139704
chore(docs): fix incorrect @returns on getter (#6175)
On a getter function you don't use `@returns` (as that's just for
methods). Instead we can just add to the general remarks to explain what
the property is providing.
2020-07-08 10:29:58 +01:00

35 lines
940 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Puppeteer](./puppeteer.puppeteer.md) &gt; [devices](./puppeteer.puppeteer.devices.md)
## Puppeteer.devices property
<b>Signature:</b>
```typescript
get devices(): DevicesMap;
```
## Remarks
A list of devices to be used with `page.emulate(options)`<!-- -->. Actual list of devices can be found in [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts)<!-- -->.
## Example
```js
const puppeteer = require('puppeteer');
const iPhone = puppeteer.devices['iPhone 6'];
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.emulate(iPhone);
await page.goto('https://www.google.com');
// other actions...
await browser.close();
})();
```