gunshi / default / resolveArgs

Function: resolveArgs()

function resolveArgs<A>(
   args, 
   tokens, 
   resolveArgs?): object;

Resolve command line arguments.

Type Parameters

Type Parameter
A extends Args

Parameters

Parameter	Type	Description
args	A	An arguments that contains arguments schema.
tokens	ArgToken[]	An array of ArgToken | tokens.
resolveArgs?	ResolveArgs	An arguments that contains ResolveArgs | resolve arguments.

Returns

object

An object that contains the values of the arguments, positional arguments, rest arguments, and AggregateError | validation errors.

error

error: undefined | AggregateError;

positionals

positionals: string[];

rest

rest: string[];

values

values: ArgValues<A>;