import {Serenity} from '@serenity-js/core'

public class | source

Serenity

You can directly use an instance of this class. serenity

Constructor Summary

Public Constructor
public	constructor()

Method Summary

Public Methods
public	announce(event: DomainEvent): void
public	assignNewActivityId(): CorrelationId
public	assignNewSceneId(): CorrelationId
public	configure(config: SerenityConfig): void Configures Serenity/JS.
public	currentSceneId(): CorrelationId
public	currentTime(): Timestamp
public	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 method 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	theActorCalled(name: string): Actor Instantiates or retrieves an actor Actor called `name` if one has already been instantiated.
public	theActorInTheSpotlight(): Actor Retrieves an actor who was last instantiated or retrieved using actorCalled.

Public Constructors

public constructor() source

Public Methods

public announce(event: DomainEvent): void source

Params:

Name	Type	Attribute	Description
event	DomainEvent

Returns:

void

public assignNewActivityId(): CorrelationId source

Returns:

CorrelationId

public assignNewSceneId(): CorrelationId source

Returns:

CorrelationId

public configure(config: SerenityConfig): void source

Configures Serenity/JS. Every call to this function replaces the previous configuration provided, so this function should called be exactly once in your test suite.

Params:

Name	Type	Attribute	Description
config	SerenityConfig

Returns:

void

public currentSceneId(): CorrelationId source

Returns:

CorrelationId

public currentTime(): Timestamp source

Returns:

Timestamp

public engage(actors: Cast): void source

Re-configures Serenity/JS with a new Cast of Actors you'd like to use in any subsequent call to actorCalled.

This method 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.

Params:

Name	Type	Attribute	Description
actors	Cast

Returns:

void

Examples:

Engaging a cast of actors

 import { Actor, Cast } from '@serenity-js/core';

 class Actors implements Cast {
     prepare(actor: Actor) {
         return actor.whoCan(
             // ... abilities you'd like the Actor to have
         );
     }
 }

engage(new Actors();

Usage with Jasmine

 import 'jasmine';

 beforeEach(() => engage(new Actors()));

Usage with Cucumber

 import { Before } from 'cucumber';

 Before(() => engage(new Actors());

See:

Actor
Cast

public theActorCalled(name: string): Actor source

Instantiates or retrieves an actor Actor called name if one has already been instantiated.

Params:

Name	Type	Attribute	Description
name	string		The name of the actor to instantiate or retrieve

Returns:

Actor

Examples:

Usage with Jasmine

  import 'jasmine';
  import { actorCalled } from '@serenity-js/core';

  describe('Feature', () => {

     it('should have some behaviour', () =>
         actorCalled('James').attemptsTo(
             // ... activities
         ));
  });

Usage with Cucumber

  import { actorCalled } from '@serenity-js/core';
  import { Given } from 'cucumber';

  Given(/(.*?) is a registered user/, (name: string) =>
     actorCalled(name).attemptsTo(
             // ... activities
         ));

See:

public theActorInTheSpotlight(): Actor source

Retrieves an actor who was last instantiated or retrieved using actorCalled.

This function is particularly useful when automating Cucumber scenarios.

Returns:

Actor

Examples:

<captiongit>Usage with Cucumber</caption>
  import { actorCalled } from '@serenity-js/core';
  import { Given, When } from 'cucumber';

  Given(/(.*?) is a registered user/, (name: string) =>
     actorCalled(name).attemptsTo(
             // ... activities
         ));

  When(/(?:he|she|they) browse their recent orders/, () =>
     actorInTheSpotlight().attemptsTo(
             // ... activities
         ));