Interface APISettings

Hierarchy

  • APISettings

Properties

consoleLog: boolean

Whether the console log is enabled. Default is true. Corresponding environment variable: CONSOLE_LOG

fileLog: boolean

Whether file logging is enabled. Default is true. Corresponding environment variable: FILE_LOG

logErrorInformation: boolean

Whether to log detailed error information. Default is true. Corresponding environment variable: `LOG_ERROR_INFORMATION´

logLevel: "error" | "debug" | "info" | "warn"

The minimimum log level that will be output. Default is "info". Corresponding environment variable: LOG_LEVEL

port: number

The API's port number. Default is 8000. Corresponding environment variable: PORT.

preferEnvironmentVariables: boolean

Whether to prefer environment variables to configure the api. Settings passed directly are still preferred. Default is false.

units: UnitConfiguration

The default units. Important: Weather data uploads have to use these units! Corresponding environment variables: RAIN_UNIT, TEMPERATURE_UNIT, ...

Generated using TypeDoc