puppeteer/website/versioned_docs/version-21.2.1/api/puppeteer.page.emulateidlestate.md
release-please[bot] a25527a223
chore: release main (#10897)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-09-13 12:29:09 +02:00

42 lines
982 B
Markdown

---
sidebar_label: Page.emulateIdleState
---
# Page.emulateIdleState() method
Emulates the idle state. If no arguments set, clears idle state emulation.
#### Signature:
```typescript
class Page {
emulateIdleState(overrides?: {
isUserActive: boolean;
isScreenUnlocked: boolean;
}): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | --------------------------------------------------------------- |
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | _(Optional)_ Mock idle state. If not set, clears idle overrides |
**Returns:**
Promise&lt;void&gt;
## Example
```ts
// set idle emulation
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});
// do some checks here
...
// clear idle emulation
await page.emulateIdleState();
```