externalScheduleWork

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

• abilityType
• repeatUntil
• waitFor
• discard
• toJSON

Constructors

externalconstructor

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

• Overrides Ability.constructor

  Parameters

  • externalclock: Clock

  • externalinteractionTimeout: Duration

  Returns ScheduleWork

Methods

externalabilityType

• abilityType(): AbilityType<Ability>

• Inherited from Ability.abilityType

  Returns the most abstract type of this Ability instance, specifically the first class in the inheritance hierarchy that directly extends the Ability class.

  import { Ability } from '@serenity-js/core';
  
  class MyAbility extends Ability {}
  class MySpecialisedAbility extends MyAbility {}
  
  new MyAbility().abilityType();            // returns MyAbility
  new MySpecialisedAbility().abilityType(); // returns MyAbility

  ---

  Returns AbilityType<Ability>

externalrepeatUntil

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

• Type parameters

  • Result

  Parameters

  • externalcallback: DelayedCallback<Result>

  • externaloptionallimits: RepeatUntilLimits<Result>

  Returns Promise<Result>

externalwaitFor

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

• Parameters

  • externaldelay: Duration

  Returns Promise<void>

externaldiscard

• discard(): void

• Implementation of Discardable.discard

  Discards the resources associated with this ability.

  ---

  Returns void

externaltoJSON

• toJSON(): SerialisedAbility

• Overrides Ability.toJSON

  Returns a JSON representation of the ability and its current state, if available. The purpose of this method is to enable reporting the state of the ability in a human-readable format, rather than to serialise and deserialise the ability itself.

  ---

  Returns SerialisedAbility