Type Alias ConfigOption<T, M, O>

ConfigOption<T, M, O>: {
    default?: ValidValue<T, M> & (O extends ReadonlyArrays
        ? M extends false
            ? O[number]
            : O[number][]
        : unknown);
    delim?: M extends false
        ? undefined
        : string;
    description?: string;
    hint?: T extends "boolean"
        ? undefined
        : string;
    multiple?: M;
    short?: string;
    type: T;
    validate?: ((v: unknown) => v is ValidValue<T, M>) | ((v: unknown) => boolean);
    validOptions?: O;
}

A config field definition, in its full representation. This is what is passed in to addFields so type is required.

Type Parameters

T extends ConfigType = ConfigType
M extends boolean = boolean
O extends undefined | ValidOptions<T> = undefined | ValidOptions<T>

Type Alias ConfigOption<T, M, O>

Type Parameters

Settings