Type alias Configuration

Configuration: {
    default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}

A configuration option.

Type declaration

  • Optional default?: any

    The default value for this option in plain JSON. Can be omitted to provide no default value.

  • Optional description?: string

    A human-readable description of the option.

  • Optional required?: boolean

    Whether the service can not function without this option. Defaults to true unless a default value is provided.

  • type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool"

    The type of value expected for this option.

Settings

Theme

Generated using TypeDoc