Type alias MinimumAPISettings

MinimumAPISettings: {
    autoStart?: boolean;
    https?: boolean;
    logOptions?: MinimumLoggerSettings;
    mongoUri?: string;
    port?: number;
    preferEnvironmentVariables?: boolean;
    sslCrtFile?: string;
    sslKeyFile?: string;
    units?: Partial<UnitConfiguration>;
}

Type declaration

  • Optional autoStart?: boolean

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

  • Optional https?: boolean

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

  • Optional logOptions?: MinimumLoggerSettings

    Configures the logging behaviour.

  • Optional mongoUri?: string

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

  • Optional port?: number

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

  • Optional preferEnvironmentVariables?: boolean

    Whether to prefer environment variables to configure the api. Default is false.

  • Optional sslCrtFile?: string

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

  • Optional sslKeyFile?: string

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

  • Optional units?: Partial<UnitConfiguration>

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

Settings

Member Visibility

Theme

Generated using TypeDoc