puppeteer/new-docs/puppeteer.page.emulateidlestate.md
Maksim Sadym 17960e5d8d
feat(page): emulate idle state (#6410)
* https://bugs.chromium.org/p/chromium/issues/detail?id=1090802
* added `page.emulateIdleState(...)` allowing emulate or remove emulation of the idle state;
* added test `emulate idle` -> `remove emulation` -> `emulate idle` -> `remove emulation`;
* added launch argument `--enable-blink-features=IdleDetection` to turn IdleDetection on.
2020-09-14 11:31:23 +02:00

983 B

Home > puppeteer > Page > emulateIdleState

Page.emulateIdleState() method

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

Signature:

emulateIdleState(overrides?: {
        isUserActive: boolean;
        isScreenUnlocked: boolean;
    }): Promise<void>;

Parameters

Parameter Type Description
overrides { isUserActive: boolean; isScreenUnlocked: boolean; } 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();