Scheduler

Index

Constructors

• constructor

Methods

• after
• waitFor
• repeatUntil
• stop

Constructors

constructor

• new Scheduler(clock: Clock, interactionTimeout: Duration): Scheduler

• Parameters

  • clock: Clock

  • interactionTimeout: Duration

    The maximum amount of time to give to a callback to complete before throwing an error

  Returns Scheduler

Methods

after

• after<Result>(delay: Duration, callback: DelayedCallback<Result>): Promise<Result>

• Schedules a callback function to be invoked after a delay

  ---

  Type parameters

  • Result

  Parameters

  • delay: Duration

  • callback: DelayedCallback<Result>

  Returns Promise<Result>

waitFor

• waitFor(delay: Duration): Promise<void>

• Returns a Promise to be resolved after a delay

  ---

  Parameters

  • delay: Duration

  Returns Promise<void>

repeatUntil

• repeatUntil<Result>(callback: DelayedCallback<Result>, limits?: RepeatUntilLimits<Result>): Promise<Result>

• Schedules a callback function to be repeated, according to configured limits.

  ---

  Type parameters

  • Result

  Parameters

  • callback: DelayedCallback<Result>

  • limits: RepeatUntilLimits<Result> = {}

  Returns Promise<Result>

stop

• stop(): void

• Returns void