Stage
Constructor Summary
| Public Constructor | ||
| public |
|
|
Member Summary
| Public Members | ||
| public |
cast: * |
|
Method Summary
| Public Methods | ||
| public |
activityDetailsFor(activity: Activity, actor: UNKNOWN): ActivityDetails |
|
| public |
Instantiates a new Actor or fetches an existing one by their name if they've already been instantiated. |
|
| public |
announce(event: DomainEvent): void |
|
| public |
assign(listeners: UNKNOWN) |
|
| public |
this method was deprecated.
|
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
theActorCalled(name: string): Actor An alias for Stage#actor |
|
| public |
Returns the last Actor instantiated via Stage#actor. |
|
| public |
theShowHasStarted(): boolean Returns {true} if there is an Actor in the spotlight, {false} otherwise. |
|
| public |
waitForNextCue(): Promise |
|
Public Constructors
public constructor() source
Public Members
public cast: * source
Public Methods
public activityDetailsFor(activity: Activity, actor: UNKNOWN): ActivityDetails source
Params:
| Name | Type | Attribute | Description |
| activity | Activity | ||
| actor | UNKNOWN |
public actor(name: string): Actor source
Instantiates a new Actor or fetches an existing one by their name if they've already been instantiated.
Params:
| Name | Type | Attribute | Description |
| name | string | case-sensitive name of the Actor |
Tests:
- Stage provides both the more verbose and more concise way of accessing the actors
- Stage when instantiating actors instantiates a new actor when their name is called for the first time
- Stage when instantiating actors returns an existing actor if it has already been instantiated before
- Stage when referencing a recently retrieved actor retrieves the current actor, if there is any
- Stage when an error occurs complains if the Cast does not provide a way to instantiate a given actor
- Stage when an error occurs complains if the Cast does not provide a way to prepare a given actor and mentions the type of the Cast, when available
- Stage when an error occurs complains if the Cast throws an error during actor instantiation
- Stage when an error occurs complains if the Cast throws an error during actor instantiation and mentions the type of the Cast, when available
public announce(event: DomainEvent): void source
Params:
| Name | Type | Attribute | Description |
| event | DomainEvent |
Returns:
| void |
public assign(listeners: UNKNOWN) source
Params:
| Name | Type | Attribute | Description |
| listeners | UNKNOWN |
public callFor(actors: Cast): Stage source
Params:
| Name | Type | Attribute | Description |
| actors | Cast |
public drawTheCurtain() source
public theActorCalled(name: string): Actor source
An alias for Stage#actor
Params:
| Name | Type | Attribute | Description |
| name | string |
See:
public theActorInTheSpotlight(): Actor source
Returns the last Actor instantiated via Stage#actor. Useful when you don't can't or choose not to reference the actor by their name.
Throws:
if no {Actor} has been activated yet |
Tests:
- Stage when referencing a recently retrieved actor provides both the more verbose and more concise way of accessing the actors in the spotlight
- Stage when referencing a recently retrieved actor provides both the more verbose and more concise way of accessing the actors in the spotlight
- Stage when referencing a recently retrieved actor complains if you try to access the actor in the spotlight, but there isn't any yet
- Stage when referencing a recently retrieved actor complains if you try to access the actor in the spotlight, but there isn't any yet