gunshi / default / resolveArgs
Function: resolveArgs()
ts
function resolveArgs<T>(options, tokens): object;Resolve command line arguments.
Type Parameters
| Type Parameter |
|---|
T extends ArgOptions |
Parameters
| Parameter | Type | Description |
|---|---|---|
options | T | An options that contains options schema. |
tokens | ArgToken[] | An array of ArgToken | tokens. |
Returns
object
An object that contains the values of the arguments, positional arguments, and AggregateError | validation errors.
error
ts
error: undefined | AggregateError;positionals
ts
positionals: string[];values
ts
values: ArgValues<T>;