externalabstractDiscardable

An interface to be implemented by any Ability that needs to free up the resources it uses, e.g. disconnect from a database.

This Discardable.discard method is invoked directly by the actor, and indirectly by the stage:

• when SceneFinishes, for actors instantiated after SceneStarts - e.g. within a test scenario or in a "before each" hook
• when TestRunFinishes, for actors instantiated before SceneStarts - e.g. in a "before all" hook

Note that events such as SceneFinishes and TestRunFinishes are emitted by Serenity/JS test runner adapters, such as @serenity-js/cucumber, @serenity-js/mocha, @serenity-js/jasmine, and so on. Consult their respective readmes to learn how to register them with your test runner of choice.

Learn more

• Ability
• AbilityType
• Initialisable

Implemented by

• ScheduleWork

Index

Constructors

• constructor

Methods

• isDiscardable
• discard

Constructors

externalconstructor

• new Discardable(): Discardable

• Returns Discardable

Methods

staticexternalisDiscardable

• isDiscardable<T>(value: T): value is T & Discardable

• Type parameters

  • T

  Parameters

  • externalvalue: T

  Returns value is T & Discardable

externalabstractdiscard

• discard(): void | Promise<void>

• Discards the resources associated with this ability.

  ---

  Returns void | Promise<void>