arg() function

Home > streplts > arg

arg() function

Functional utility constructing typed and structured command option values.

Signature:

arg: (name: string, opts?: {
    required?: boolean;
    choices?: ArgDefinition["choices"];
}) => {
    name: string;
    required: boolean;
    choices: string[] | ((typed: string, previousArgs: string[], context: any, globals: any) => string[]) | null;
}

Parameters

Parameter	Type	Description
name	string	Positional tracking key descriptive label.
opts	{ required?: boolean; choices?: ArgDefinition[“choices”]; }	(Optional) Object constraints structuring optional/required flags and choice filters.

Returns:

{ name: string; required: boolean; choices: string[] | ((typed: string, previousArgs: string[], context: any, globals: any) => string[]) | null; }

An unified configuration blueprint matching ArgDefinition constraints. *