Type alias MinimumAPISettings

MinimumAPISettings: {
    consoleLog?: boolean;
    fileLog?: boolean;
    logErrorInformation?: boolean;
    logLevel?: "debug" | "info" | "warn" | "error";
    port?: number;
    preferEnvironmentVariables?: boolean;
    units?: Partial<UnitConfiguration>;
}

Type declaration

  • Optional consoleLog?: boolean

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

  • Optional fileLog?: boolean

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

  • Optional logErrorInformation?: boolean

    Whether to log detailed error information. Default is true.

  • Optional logLevel?: "debug" | "info" | "warn" | "error"

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

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