Class: Stage
A class impementing the Stages SDK
Extends
TypedEmitter\<StageEventMap>
Constructors
new Stage()
new Stage(
token,strategy):Stage
Creates an instance of a Stage
Parameters
• token: string
The token to join this stage as
• strategy: StageStrategy
The [[StageStrategy]] to use for this Stage
Returns
Overrides
TypedEmitter<StageEventMap>.constructor
Methods
join()
join():
Promise\<void>
Joins the stage
Returns
Promise\<void>
leave()
leave():
void
Leaves the stage
Returns
void
off()
off\<
E>(event,callback,context?):void
De-register a callback for event E
Type Parameters
• E extends keyof StageEventMap
Parameters
• event: E
the event to de-register the callback for
• callback: StageEventMap[E]
the callback to be de-registered
• context?: any
Returns
void
Inherited from
TypedEmitter.off
on()
on\<
E>(event,callback,context?):void
Register a new callback for event E
Type Parameters
• E extends keyof StageEventMap
Parameters
• event: E
the event to register the callback for
• callback: StageEventMap[E]
the callback to be invoked for the event
• context?: any
Returns
void
Inherited from
TypedEmitter.on
refreshStrategy()
refreshStrategy():
void
Re-executes the [[StageStrategy]]
Returns
void
replaceStrategy()
replaceStrategy(
strategy):void
Updates and re-executes the [[StageStrategy]]
Parameters
• strategy: StageStrategy
The new [[StageStrategy]] for the stage
Returns
void