Type alias ConfigOptionBase<T, M>

ConfigOptionBase<T, M>: {
    default?: ValidValue<T, M>;
    description?: string;
    hint?: T extends "boolean"
        ? undefined
        : string | undefined;
    short?: string;
    type: T;
    validOptions?: T extends "boolean"
        ? undefined
        : T extends "string"
            ? readonly string[]
            : T extends "number"
                ? readonly number[]
                : readonly number[] | readonly string[];
    validate?: ((v) => v is ValidValue<T, M>);
} & MultiType<M>

A config field definition, in its full representation.

Type Parameters

Type declaration

  • Optional default?: ValidValue<T, M>
  • Optional description?: string
  • Optional hint?: T extends "boolean"
        ? undefined
        : string | undefined
  • Optional short?: string
  • type: T
  • Optional validOptions?: T extends "boolean"
        ? undefined
        : T extends "string"
            ? readonly string[]
            : T extends "number"
                ? readonly number[]
                : readonly number[] | readonly string[]
  • Optional validate?: ((v) => v is ValidValue<T, M>)

Settings

Member Visibility

Theme

Generated using TypeDoc