ScheduleWork

experimental

An Ability that enables an Actor to schedule a callback function to be executed with a delay, or until some condition is met.

Used internally by the interaction to Wait.

Hierarchy

• Ability
  • ScheduleWork

Implements

• Discardable

Index

Constructors

• constructor

Methods

• repeatUntil
• waitFor
• discard

Constructors

constructor

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

• Overrides Ability.constructor

  Parameters

  • clock: Clock

  • interactionTimeout: Duration

  Returns ScheduleWork

Methods

repeatUntil

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

• Type parameters

  • Result

  Parameters

  • callback: DelayedCallback<Result>

  • optionallimits: RepeatUntilLimits<Result>

  Returns Promise<Result>

waitFor

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

• Parameters

  • delay: Duration

  Returns Promise<void>

discard

• discard(): void

• Implementation of Discardable.discard

  Discards the resources associated with this ability.

  ---

  Returns void