Main Class for Framework
Methods
# static listEnvs() → {Array.<string>}
Returns all registered environment names
a list of environment names
Array.<string>
# static loadEnv(name, optionsnullable, initialStatenullable) → {Environment|undefined}
load a registered environment class
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string
|
Name of the environment |
|
options |
EnvOptions
|
<nullable> |
options to use for instantiating environment |
initialState |
object
|
<nullable> |
initial state of the environment |
an instatiated object of the environment or undefined
Environment
|
undefined
# static register(name, envtype)
Register a new environment within the framework.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string
|
name of the environment to register. |
envtype |
EnvType
|
The referenct to the environment class |