Type Alias JimpexConfigOptions

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'
  Copy

• environmentVariable: string

  The name of the environment variable that will be used to set the active configuration.

  Default

  'CONFIG'
  Copy

• filenameFormat: string

  The name format of other external configuration files.

  Default

  '[app-name].[config-name].config.js'
  Copy

• 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
  Copy

• loadFromEnvironment: boolean

  Whether or not to check for the environment variable and load a configuration file based on its value.

  Default

  true
  Copy

• name: string

  The name of the application, used for external configuration files.

  Default

  'app'
  Copy

• path: string

  The path to where external configuration files are stored. Relative to the project root.

  Default

  'config/'
  Copy