Skip to main content

Options type

Signature:
export declare type Options<T, O> = yargs.Options & {
coerce?: (arg: any) => T;
choices?: readonly T[];
default?: T | (() => T | undefined);
conflicts?: OptionKeyRefs<keyof O>;
implies?: OptionKeyRefs<keyof O>;
} & (T extends string ? {
type: "string";
} | {
string: true;
} : T extends number ? {
type: "number" | "count";
} | {
number: true;
} | {
count: true;
} : T extends boolean ? {
type: "boolean";
} | {
boolean: true;
} : T extends any[] ? {
type: "array";
} | {
array: true;
} : unknown);
References: [OptionKeyRefs](/docs/api/template.optionkeyrefs)