Parameters
- schema: S
- overwrites: O = ...
Returns {
alias: undefined | string | readonly string[];
coerce: undefined | ((arg: any) => any);
config: undefined | boolean;
configParser: undefined | ((configPath: string) => object);
conflicts:
| undefined
| string
| readonly string[]
| {
[key: string]: string | readonly string[];
};
count: undefined | boolean;
default: undefined | Static<S>;
defaultDescription: undefined | string;
demandOption: string | boolean;
deprecated: undefined | string | boolean;
describe: undefined | string;
global: undefined | boolean;
group: undefined | string;
hidden: undefined | boolean;
implies:
| undefined
| string
| readonly string[]
| {
[key: string]: string | readonly string[];
};
nargs: undefined | number;
normalize: undefined | boolean;
requiresArg: undefined | boolean;
skipValidation: undefined | boolean;
type: "array";
} & {
choices: GetChoices<S["items"]>;
} & O
applicable yargs options in schema and overwrites
Transform TypeBox TArray schema and options appended in schema to yargs options.
If the array items is Literal or Union of Literal, the choices will be set to the const value of the Literal or Union of Literal. Otherwise, the choices will be undefined.