externalCheck <Actual>

A flow control statement that enables an Actor to decide between two alternate series of activities.

Think of it as a Screenplay Pattern equivalent of the traditional if statement.

Choose between two alternative sequences of activities

import { equals } from '@serenity-js/assertions'
import { actorCalled, Check } from '@serenity-js/core'

await actorCalled('Chuck').attemptsTo(
  Check.whether(process.env.MODE, equals('prod'))
    .andIfSo(
      LogInAsProdUser(),
    )
    .otherwise(
      LogInAsTestUser(),
    )
)

Perform a sequence of activities when a condition is met

import { actorCalled, Check } from '@serenity-js/core'
import { isVisible } from '@serenity-js/web'

await actorCalled('Chuck').attemptsTo(
  Check.whether(CookieConsentBanner(), isVisible())
    .andIfSo(
        AcceptNecessaryCookies(),
    )
)

Hierarchy

• Task
  • Check

Index

Methods

• whether
• instantiationLocation
• otherwise
• performAs
• describedBy
• toString

Methods

staticexternalwhether

• whether<Actual_Type>(actual: Answerable<Actual_Type>, expectation: Expectation<Actual_Type>): { andIfSo: (...activities: Activity[]) => Check<Actual_Type> }

• Type parameters

  • Actual_Type

  Parameters

  • externalactual: Answerable<Actual_Type>

  • externalexpectation: Expectation<Actual_Type>

  Returns { andIfSo: (...activities: Activity[]) => Check<Actual_Type> }

  • externalandIfSo: (...activities: Activity[]) => Check<Actual_Type>

    • • (...activities: Activity[]): Check<Actual_Type>

      • Parameters

        • externalrest...activities: Activity[]

        Returns Check<Actual_Type>

externalinstantiationLocation

• instantiationLocation(): FileSystemLocation

• Inherited from Task.instantiationLocation

  Returns the location where this Activity was instantiated.

  ---

  Returns FileSystemLocation

externalotherwise

• otherwise(...alternativeActivities: Activity[]): Task

• Parameters

  • externalrest...alternativeActivities: Activity[]

    A sequence of activities to perform when the Expectation is not met.

  Returns Task

externalperformAs

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

• Overrides Task.performAs

  Instructs the provided Actor to perform this Task.

  ---

  Parameters

  • externalactor: AnswersQuestions & PerformsActivities

    Learn more

    • Actor
    • PerformsActivities
    • Activity

  Returns Promise<void>

externaldescribedBy

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

• Inherited from Task.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 Task.toString

  Returns a human-readable description of this object.

  ---

  Returns string