Class Ui5Clock

Controls the browser clock for date-driven SAP tests.

Remarks

Call install first — the other methods throw until you do, because Playwright silently ignores clock control on an uninstalled clock, which is a confusing way to lose an afternoon.

Capability

ui5Clock.install

Example

const clock = new Ui5Clock({ page });
await clock.install('2026-03-31T12:00:00Z');
await clock.fastForward('30:00'); // 30 minutes later

Index

Constructors

constructor

new Ui5Clock(options: Ui5ClockOptions): Ui5Clock
Parameters
- options: Ui5ClockOptions
Returns Ui5Clock
- Defined in fixtures/clock-handler.ts:103

Accessors

installed

get installed(): boolean
Whether install has run.

Returns boolean
Example
```
if (!clock.installed) await clock.install();
```
- Defined in fixtures/clock-handler.ts:116

Methods

fastForward

fastForward(ticks: string | number): Promise<void>
Jumps forward, firing any timers scheduled in between.
Parameters
- ticks: string | number
  Milliseconds, or a "mm:ss" / "hh:mm:ss" string.
Returns Promise<void>
Capability
ui5Clock.fastForward
Example
```
await clock.fastForward('30:00'); // 30 minutes
```
- Defined in fixtures/clock-handler.ts:181

install

install(time?: ClockTime): Promise<void>
Installs the fake clock, optionally at a specific time.
Parameters
- Optionaltime: ClockTime
  Initial time. Omit to install at the current real time.
Returns Promise<void>
Remarks
Install before navigating where possible, so the application sees the faked time from its first render.

Throws
PramanError with ERR_COMPAT_FEATURE_UNAVAILABLE when Playwright predates 1.45.

Capability
ui5Clock.install
Example
```
await clock.install('2026-03-31T12:00:00Z');
```
- Defined in fixtures/clock-handler.ts:138

pauseAt

pauseAt(time: ClockTime): Promise<void>
Advances to a time, pausing there.
Parameters
- time: ClockTime
  The time to pause at.
Returns Promise<void>
Capability
ui5Clock.pauseAt
Example
```
await clock.pauseAt('2026-06-30T00:00:00Z'); // period close
```
- Defined in fixtures/clock-handler.ts:198

resume

resume(): Promise<void>
Resumes normal time flow after a pause.

Returns Promise<void>
Capability
ui5Clock.resume
Example
```
await clock.resume();
```
- Defined in fixtures/clock-handler.ts:213

runFor

runFor(ticks: string | number): Promise<void>
Runs the clock forward, firing timers, without jumping.
Parameters
- ticks: string | number
  Milliseconds, or a "mm:ss" / "hh:mm:ss" string.
Returns Promise<void>
Capability
ui5Clock.runFor
Example
```
await clock.runFor(5_000);
```
- Defined in fixtures/clock-handler.ts:230

setFixedTime

setFixedTime(time: ClockTime): Promise<void>
Pins the clock to a fixed time without affecting timers.
Parameters
- time: ClockTime
  The time to report.
Returns Promise<void>
Capability
ui5Clock.setFixedTime
Example
```
await clock.setFixedTime('2026-12-31T23:59:00Z');
```
- Defined in fixtures/clock-handler.ts:164

Class Ui5Clock

Remarks

Capability

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Ui5Clock

Accessors

installed

Returns boolean

Example

Methods

fastForward

Parameters

Returns Promise<void>

Capability

Example

install

Parameters

Returns Promise<void>

Remarks

Throws

Capability

Example

pauseAt

Parameters

Returns Promise<void>

Capability

Example

resume

Returns Promise<void>

Capability

Example

runFor

Parameters

Returns Promise<void>

Capability

Example

setFixedTime

Parameters

Returns Promise<void>

Capability

Example

Settings

On This Page