jackspeak
    Preparing search index...

    Type Alias ConfigOption<T, M, O>

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

    type ConfigOption<
        T extends ConfigType = ConfigType,
        M extends boolean = boolean,
        O extends undefined | ValidOptions<T> = undefined | ValidOptions<T>,
    > = {
        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;
    }

    Type Parameters

    Index

    Properties

    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