Class CamundaClock

Utility class for managing Zeebe's clock in test environments. Uses the undocumented /actuator/clock REST API endpoints. Properly handles container host resolution for cross-platform compatibility.

⚠️ IMPORTANT: Clock manipulation may fail in REMOTE mode (SaaS/C8Run environments). For reliable timer testing, use MANAGED mode with Docker containers.

Constructors

constructor

Methods

addTime advanceTime getCurrentTime resetClock

Constructors

constructor

Methods

addTime

  • addTime(offsetMillis): Promise<void>

  • Advance the clock by the specified number of milliseconds.

    ⚠️ Warning: May fail in REMOTE mode (SaaS/C8Run). Use MANAGED mode for reliable timer testing.

    Parameters

    • offsetMillis: number

    Returns Promise<void>

advanceTime

  • advanceTime(amount, unit?): Promise<void>

  • Advance the clock by the specified duration. Supports common time units.

    ⚠️ Warning: May fail in REMOTE mode (SaaS/C8Run). Use MANAGED mode for reliable timer testing.

    Parameters

    • amount: number
    • unit:
          | "milliseconds"
          | "seconds"
          | "minutes"
          | "hours"
          | "days" = 'milliseconds'

    Returns Promise<void>

getCurrentTime

resetClock

  • resetClock(): Promise<void>

  • Reset the clock to the system time.

    ⚠️ Warning: May fail in REMOTE mode (SaaS/C8Run). Use MANAGED mode for reliable timer testing.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Methods