Instantiate SakuraApiConfig.
The configuration that was loaded from the various json and ts files and the environmental variables that were set at the time the configuration was last loaded.
Looks for a dbConnections property in the root of config. If one is found, it expects the
following:
{
"dbConnections": [
{
"name": "someDb1",
"url": "mongodb://localhost:1234/somedb1",
"mongoClientOptions": {}
},
{
"name": "someDb2",
"url": "mongodb://localhost:1234/somedb2",
"mongoClientOptions": {}
}
]
}
Where someDb1 is the name of the connection that you can use for retrieving the connection with
SakuraMongoDbConnection.getDb('someDb1').
Loads the config file specified by path. If no path is provided, load the path/filename defined in environmental
variable SAKURA_API_CONFIG, otherwise load config/environment.json from the root of the project.
SakuraApi looks for a config/ folder in the root of your api project. It cascades the values found in the following order (the last taking precedence over the former):
Where {env} is replaced by what's set in the environmental variable NODE_ENV. For example, if your set
NODE_ENV=dev when you start your server, the system will load:
Same as the instance method, but static, and it won't try to use the last loaded config since that requires an instance.
Generated using TypeDoc
SakuraApiConfig loads and manages the cascading configuration files of SakuraApi. The configuration is deep merged. See SakuraApiConfig.load for details.