externalWaitUntil <Actual>

Synchronisation statement that instructs the Actor to wait before proceeding until a given Expectation is met.

To instantiate the interaction to WaitUntil, use the factory method Wait.until.

Learn more

• Wait.until

Hierarchy

• Interaction
  • WaitUntil

Index

Constructors

• constructor

Methods

• instantiationLocation
• describedBy
• toString
• pollingEvery
• performAs

Constructors

externalconstructor

• new WaitUntil<Actual>(actual: Answerable<Actual>, expectation: Expectation<Actual>, pollingInterval: Duration, timeout?: Duration): WaitUntil<Actual>

• Overrides Interaction.constructor

  Type parameters

  • Actual

  Parameters

  • externalactual: Answerable<Actual>

  • externalexpectation: Expectation<Actual>

  • externalpollingInterval: Duration

  • externaloptionaltimeout: Duration

  Returns WaitUntil<Actual>

Methods

externalinstantiationLocation

• instantiationLocation(): FileSystemLocation

• Inherited from Interaction.instantiationLocation

  Returns the location where this Activity was instantiated.

  ---

  Returns FileSystemLocation

externaldescribedBy

• describedBy(actor: AnswersQuestions & UsesAbilities & { name: string }): Promise<string>

• Inherited from Interaction.describedBy

  Resolves the description of this object in the context of the provided actor.

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities & { name: string }

  Returns Promise<string>

externaltoString

• toString(): string

• Inherited from Interaction.toString

  Returns a human-readable description of this object.

  ---

  Returns string

externalpollingEvery

• pollingEvery(interval: Duration): Interaction

• Configure how frequently the Actor should check if the answer meets the expectation.

  Note that the polling interval defines the delay between subsequent attempts to evaluate the expected value, and doesn't include the amount of time it take the actor to evaluate the value itself.

  ---

  Parameters

  • externalinterval: Duration

  Returns Interaction

externalperformAs

• performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>

• Overrides Interaction.performAs

  Instructs the provided Actor to perform this Interaction.

  Learn more

  • Actor
  • PerformsActivities
  • UsesAbilities
  • AnswersQuestions

  ---

  Parameters

  • externalactor: UsesAbilities & AnswersQuestions

  Returns Promise<void>