Type alias ConfigOptionMeta<T, M>

ConfigOptionMeta<T, M>: {
    default?: ValidValue<T, M>;
    description?: string;
    short?: string;
    type?: T;
    validate?: ((v) => v is ValidValue<T, M>) | ((v) => boolean);
} & (T extends "boolean"
    ? {}
    : {
        hint?: string;
    }) & (M extends false
    ? {}
    : {
        delim?: string;
        multiple?: M;
    })

The meta information for a config option definition, when the type and multiple values can be inferred by the method being used

Type Parameters

Type declaration

  • Optional default?: ValidValue<T, M>
  • Optional description?: string
  • Optional short?: string
  • Optional type?: T
  • Optional validate?: ((v) => v is ValidValue<T, M>) | ((v) => boolean)

Generated using TypeDoc