Interface APISettings

Hierarchy

  • APISettings

Properties

autoStart: boolean

Whether the api should automatically start the http(s) server after being configured. Default is true. Corresponding environment variable: AUTOSTART.

https: boolean

Whether to use https. Default is false. Corresponding environment variable: HTTPS

logOptions: default

Configures the logging behaviour.

mongoUri: string

The connection string used to connect to mongodb. Default is mongodb://127.0.0.1:27017. Corresponding environment variable: MONGO_URI

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.

sslCrtFile: string

The path to your ssl public certificate. Corresponding environment variable: SSL_CRT_FILE

sslKeyFile: string

The path to your ssl private key. Corresponding environment variable: SSL_KEY_FILE

units: UnitConfiguration

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

Generated using TypeDoc