puppeteer/docs/api/puppeteer.page.emulateidlestate.md
Miki Lombardi 39e3d4bceb docs: Upgrading to Docusaurus V3 (#11434)
Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
2023-11-29 13:08:08 +01:00

1021 B

sidebar_label
Page.emulateIdleState

Page.emulateIdleState() method

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

Signature:

class Page {
  abstract 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();