Type alias JimpexConfigOptions

JimpexConfigOptions: {
    default: unknown;
    defaultConfigFilename: string;
    environmentVariable: string;
    filenameFormat: string;
    hasFolder: boolean;
    loadFromEnvironment: boolean;
    name: string;
    path: string;
}

The options for the application's configuration service.

Type declaration

default: unknown
The default settings for the configuration. If no external configuration is used, this needs to include a port property.
defaultConfigFilename: string
The name of the default configuration file.
Default
```
'[app-name].config.js'
```
environmentVariable: string
The name of the environment variable that will be used to set the active configuration.
Default
```
'CONFIG'
```
filenameFormat: string
The name format of other external configuration files.
Default
```
'[app-name].[config-name].config.js'
```
hasFolder: boolean
Whether the configuration files are inside a sub directory or not. If true, a configuration path would be config/[app-name]/[file].
Default
```
false
```
loadFromEnvironment: boolean
Whether or not to check for the environment variable and load a configuration file based on its value.
Default
```
true
```
name: string
The name of the application, used for external configuration files.
Default
```
'app'
```
path: string
The path to where external configuration files are stored. Relative to the project root.
Default
```
'config/'
```

See

https://www.npmjs.com/package/@homer0/simple-config

Type alias JimpexConfigOptions

Type declaration

default: unknown

defaultConfigFilename: string

Default

environmentVariable: string

Default

filenameFormat: string

Default

hasFolder: boolean

Default

loadFromEnvironment: boolean

Default

name: string

Default

path: string

Default

See

Settings

Member Visibility

Theme