cli-flags/lib/flags.d.ts

import { AlphabetLowercase, AlphabetUppercase } from './alphabet';
import { ParserInput } from './parse';
export interface IFlagBase {
    name: string;
    char?: AlphabetLowercase | AlphabetUppercase;
    description?: string;
    hidden?: boolean;
    required?: boolean;
}
export interface IBooleanFlag extends IFlagBase {
    type: 'boolean';
    allowNo: boolean;
    value: boolean;
    input: string;
}
export declare type ParseContext = {
    [k: string]: any;
};
export declare type FlagParseContext<T, PC extends ParseContext> = {
    flag: IOptionFlag<T>;
    input: ParserInput;
} & PC;
export declare type ParseFn<T, PC = any> = (input: string, parseContext: FlagParseContext<T, PC>) => T;
export interface IOptionFlagBase<T> extends IFlagBase {
    type: 'option';
    parse: ParseFn<T>;
    input: string[];
}
export interface IOptionalFlag<T> extends IOptionFlagBase<T> {
    multiple: false;
    default?: T | ((context: ParseContext) => T);
    value?: T;
}
export interface IRequiredFlag<T> extends IOptionFlagBase<T> {
    multiple: false;
    default?: undefined;
    value: T;
}
export interface IMultiOptionFlag<T> extends IOptionFlagBase<T> {
    multiple: true;
    default?: undefined;
    value: T[];
}
export declare type IOptionFlag<T> = IOptionalFlag<T> | IRequiredFlag<T> | IMultiOptionFlag<T>;
export declare type FlagBuilder<T> = {
    (options: Partial<IMultiOptionFlag<T>> & {
        multiple: true;
    }): IMultiOptionFlag<T>;
    (options: Partial<IRequiredFlag<T>> & {
        required: true;
    }): IRequiredFlag<T>;
    (options?: Partial<IOptionalFlag<T>>): IOptionalFlag<T>;
};
export declare function option<T = string>(defaults?: Partial<IOptionFlag<T>>): FlagBuilder<T>;
export declare type IFlag<T> = IBooleanFlag | IOptionFlag<T>;
export declare const flags: {
    boolean: (options?: Partial<IBooleanFlag>) => IBooleanFlag;
    integer: FlagBuilder<number>;
    option: <T = string>(defaults?: Partial<IOptionalFlag<T>> | Partial<IRequiredFlag<T>> | Partial<IMultiOptionFlag<T>>) => FlagBuilder<T>;
    string: FlagBuilder<string>;
};
export declare const defaultFlags: {
    color: IBooleanFlag;
};