Class ApiXConfig

An object that represents the configuration of the API. By default, configuration files are expected to be named apix.config.json.

A typical config file will look like this:

{
  "host": "127.0.0.1",
  "port": 3000,
  "maxRequestAge": 60000
}

Index

Constructors

Methods

setValueForKey valueForKey

Constructors

constructor

new ApiXConfig(configFile?): ApiXConfig
Creates a new configuration object.
Parameters
- configFile: string = 'apix.config.json'
  The path to the configuration file. Defaults to apix.config.json.
Returns ApiXConfig
- Defined in src/apixlib/ApiXConfig.ts:54

Methods

setValueForKey

setValueForKey<T>(value, key): void
Retrieves a value for a key.
Type Parameters
- T
Parameters
- value: T
  the value to set for the key.
- key: string
  key in config.
Returns void
- Defined in src/apixlib/ApiXConfig.ts:98

valueForKey

valueForKey<T>(key): undefined | T
Retrieves a value for a key.
Type Parameters
- T
Parameters
- key: string
  key in config.
Returns undefined | T
value for provided key.
Example
```
const port = config.valueForKey<number>(ApiXConfigKey.Port) || 3000;
```
- Defined in src/apixlib/ApiXConfig.ts:89