Skip to main content

externalabstractSerenityConfig

Describes the configuration object accepted by the configure function.

Learn more

Index

Constructors

Properties

Constructors

externalconstructor

Properties

externaloptionalactors

actors?: Cast

A cast of actors to be used when actorCalled and actorInTheSpotlight functions are called.

externaloptionalcrew

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

A list of stage crew member builders or stage crew members to be notified of Serenity/JS domain events that occur during the scenario execution.

Note that the crew can also be configured using class descriptions. 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).

externaloptionalcueTimeout

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.

externaloptionalinteractionTimeout

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

externaloptionaldiffFormatter

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

externaloptionaloutputStream

outputStream?: OutputStream

An output stream to be injected into stage crew member builders

Defaults to process.stdout.