API Reference

summary
public	C Serenity
public	I SerenityConfig
public	F actorCalled(name: string): Actor Instantiates or retrieves an actor Actor called `name` if one has already been instantiated.
public	F actorInTheSpotlight(): Actor Retrieves an actor who was last instantiated or retrieved using actorCalled.
public	F configure(config: SerenityConfig): void Configures Serenity/JS.
public	F engage(actors: Cast): void Re-configures Serenity/JS with a new Cast of Actors you'd like to use in any subsequent call to actorCalled. This function provides an alternative to calling Actor#whoCan directly in your tests and you'd typically us it in a "before each" hook of your test runner of choice.
public	V serenity: Serenity

errors

summary
public	C AssertionError Thrown to indicate that an assertion has failed.
public	C ConfigurationError Thrown to indicate that a test framework or test suite configuration error occurs.
public	C ImplementationPendingError Thrown to indicate that the Actor attempted to perform a Task or Interaction that hasn't been implemented yet.
public	C LogicError Thrown to indicate that an Interaction, a Task or a test scenario can't be executed due to a logical error. For example, it's not possible to assert on the last HTTP Response if the request hasn't been performed yet.
public	C RuntimeError Base class for custom errors that may occur during execution of a test scenario.
public	C TestCompromisedError Thrown to indicate that the test can't be performed due to an issue with a downstream dependency. For example, it makes no sense to run a full-stack integration test if we already know that the database server is down.
public	C UnknownError Thrown to indicate that an unknown error has occurred.

events

summary
public	C ActivityFinished
public	C ActivityRelatedArtifactArchived
public	C ActivityRelatedArtifactGenerated
public	C ActivityStarts
public	C ArtifactArchived
public	C ArtifactGenerated
public	C AsyncOperationAttempted
public	C AsyncOperationCompleted
public	C AsyncOperationFailed
public	C DomainEvent
public	C FeatureNarrativeDetected
public	C InteractionFinished
public	C InteractionStarts
public	C SceneBackgroundDetected
public	C SceneDescriptionDetected
public	C SceneFinished
public	C SceneFinishes
public	C SceneParametersDetected
public	C SceneSequenceDetected
public	C SceneStarts
public	C SceneTagged
public	C SceneTemplateDetected
public	C TaskFinished
public	C TaskStarts
public	C TestRunFinished Emitted when all the tests have finished running.
public	C TestRunFinishes Emitted when the last test in the test suite has finished running and it's time for any last-minute reporting to take place.
public	C TestRunnerDetected
public	C TestSuiteFinished
public	C TestSuiteStarts

io

summary
public	C AssertionReportDiffer
public	C ErrorSerialiser
public	C FileSystem
public	C FileSystemLocation
public	C ModuleLoader
public	C Path
public	C Version
public	I SerialisedError
public	F formatted(templates: TemplateStringsArray, placeholders: Array<Answerable<any>>): string A tag function returning a human-readable description of a template containing one or more Answerables.
public	F inspected(value: Answerable<any>): string Provides a human-readable description of the {@link Answerable<T>}.
public	F trimmed(templates: TemplateStringsArray, placeholders: Array<string>): string A tag function trimming the leading and trailing whitespace from multi-line strings.

model

summary
public	C ActivityDetails
public	C Artifact
public	C Category
public	C CorrelationId
public	C Description
public	C Duration
public	C Name
public	C ScenarioDetails
public	C ScenarioParameters
public	C TestSuiteDetails
public	C Timestamp
public	C ExecutionCompromised Indicates a failure due to external events or systems that compromise the validity of the test.
public	C ExecutionFailedWithAssertionError Execution of an Activity or Scene has failed due to an assertion error;
public	C ExecutionFailedWithError Indicates a failure due to an error other than recognised external system and assertion failures
public	C ExecutionIgnored The result of the scenario should be ignored, most likely because it's going to be retried.
public	C ExecutionSkipped The Activity was not executed because a previous one has failed.
public	C ExecutionSuccessful Scenario or activity ran as expected.
public	C ImplementationPending A pending Activity is one that has been specified but not yet implemented.
public	C Outcome
public	C ProblemIndication

model/artifacts

summary
public	C AssertionReport
public	C HTTPRequestResponse An Artifact describing a HTTP request/response pair.
public	C JSONData
public	C LogEntry
public	C Photo
public	C TestReport
public	C TextData
public	I RequestAndResponse The value of the HTTPRequestResponse Artifact describing a HTTP request/response pair.

model/tags

summary
public	C ArbitraryTag Tagged with an arbitrary tag that doesn't have any special interpretation such as @regression, @wip, etc.
public	C BrowserTag
public	C CapabilityTag
public	C ContextTag this class was deprecated. There are a couple of common use-cases for contexts: running the same test in different browsers, and running the same test on different operating systems.
public	C ExecutionRetriedTag Indicates that execution of a given scene has been retried for the `currentRetry`-th time.
public	C FeatureTag
public	C IssueTag
public	C ManualTag
public	C PlatformTag
public	C Tag
public	C ThemeTag

screenplay

summary
public	C Interaction Directly exercises the Actor's Ability to interact with the System Under Test.
public	C Question Enables the Actor to query the system under test.
public	C Task Aggregates Interactions so that they represents logical steps of a business process an Actor can perform.
public	I Ability An Ability enables the Actor to interact with an external interface of the system under test.
public	I AbilityType An interface describing the static access method that every Ability class needs to provide in order to be accessible from within an Interaction.
public	I Activity A command object representing an activity that an Actor can perform.
public	I Discardable An interface to be implemented by any Ability that needs to free up any resources it's using when the test scenario finishes.
public	T Answerable<T>: Question<Promise<T>> \| Question<T> \| Promise<T> \| T

screenplay/abilities

summary
public	C TakeNotes Enables the Actor to TakeNote of an answer to a given Question and to retrieve their Note later.

screenplay/actor

summary
public	C Actor
public	I AnswersQuestions Enables the Actor to answer a Question about the system under test
public	I CanHaveAbilities Enables the Actor to have an Ability or Abilities to perform some Activity.
public	I CollectsArtifacts Enables the Actor to collect Artifacts while the scenario is being executed
public	I ListensToDomainEvents A StageCrewMember or an Actor that can listen and react to DomainEvents
public	I PerformsActivities Enables the Actor to perform an Activity, such as a Task or an Interaction
public	I UsesAbilities Enables the Actor to use an Ability to perform some Activity.

screenplay/interactions

summary
public	C Log Enables the Actor to log arbitrary static values and answers to Questions, so that they can be printed to the terminal by the `ConsoleReporter` and attached to the HTML report by the `SerenityBDDReporter`.
public	C See this class was deprecated.
public	C TakeNote Enables the Actor to remember an answer to a given Question, and recall it later.

screenplay/questions

summary
public	C Note Enables the Actor to recall an answer to a given Question, recorded using TakeNote.
public	C Transform this class is experimental.

stage

summary
public	C Clock A Clock tells the time.
public	C Stage
public	C StageManager
public	I Cast Describes the Actors available to take part in the performance.
public	I DressingRoom this class was deprecated. Please use the Cast instead Prepares the Actor for the performance.
public	I StageCrewMember You can think of the StageCrewMember as an in-memory micro-service that reacts to DomainEvents from the StageManager.
public	I WithStage this class was deprecated. Please use serenity.actor() and serenity.actorInTheSpotlight() instead Makes the Stage object setup in your test runner configuration visible to test steps or test scenarios.

stage/crew/artifact-archiver

summary
public	C ArtifactArchiver Stores any Artifacts emitted through ArtifactGenerated events on the FileSystem

stage/crew/stream-reporter

summary
public	C StreamReporter Serialises all the DomainEvent objects it receives and streams them as ndjson to the output stream.

Directories