puppeteer/website/versioned_docs/version-16.1.0/api/puppeteer.page.emulateidlestate.md
release-please[bot] 2d5f216621
chore(main): release 16.1.0 (#8743)
* chore(main): release 16.1.0

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-08-06 16:49:20 +02:00

996 B

sidebar_label
Page.emulateIdleState

Page.emulateIdleState() method

Emulates the idle state. If no arguments set, clears idle state emulation.

Signature:

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<void>

Example

// set idle emulation
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});

// do some checks here
...

// clear idle emulation
await page.emulateIdleState();