puppeteer/website/versioned_docs/version-19.8.2/api/puppeteer.page.emulateidlestate.md

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();