Skip to main content

abstractSerenityConfig

Describes the configuration object accepted by the configure function.

Learn more

Index

Constructors

Properties

Constructors

constructor

Properties

optionalactors

actors?: Cast

A Cast of Actors to be used when actorCalled and actorInTheSpotlight functions are called.

optionalcrew

crew?: (StageCrewMember | StageCrewMemberBuilder<ListensToDomainEvents> | ClassDescription)[]

A list of StageCrewMemberBuilders or StageCrewMembers to be notified of DomainEvents that occur during the scenario execution.

Note that the crew can also be configured using ClassDescriptions. This is useful when you need to load the configuration from a static json file, or when the test runner doesn’t support providing class instances in configuration (e.g. Playwright Test).

optionalcueTimeout

cueTimeout?: Duration

The maximum amount of time between SceneFinishes and SceneFinished events that Serenity/JS should wait for any post-scenario async operations to complete. Those include generating the screenshots, saving reports to disk, dismissing the actors, and so on.

Defaults to 5 seconds.

Please note that this is not a scenario timeout, which should be configured in your test runner.

optionalinteractionTimeout

interactionTimeout?: Duration

The maximum default amount of time allowed for interactions such as Wait.until to complete.

Defaults to 5 seconds, can be overridden per interaction.

Please note that this is not a scenario timeout, which should be configured in your test runner.

Learn more

optionaldiffFormatter

diffFormatter?: DiffFormatter

DiffFormatter that should be used by the ErrorFactory and the ability to RaiseErrors when generating diffs included in RuntimeError objects.

By default, Serenity/JS uses NoOpDiffFormatter.

optionaloutputStream

outputStream?: OutputStream

An output stream to be injected into StageCrewMemberBuilders

Defaults to process.stdout.