gunshi / default / resolveArgs

Function: resolveArgs()

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

Resolve command line arguments.

Type Parameters

Type Parameter	Description
A extends Args	Arguments, which is an object that defines the command line arguments.

Parameters

Parameter	Type	Description
args	A	An arguments that contains arguments schema.
tokens	ArgToken[]	An array of 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, AggregateError | validation errors, and explicit provision status.

error

error: undefined | AggregateError;

explicit

explicit: ArgExplicitlyProvided<A>;

positionals

positionals: string[];

rest

rest: string[];

values

values: ArgValues<A>;

Example

// passed tokens: --port 3000

const { values, explicit } = resolveArgs({
  port: {
    type: 'number',
    default: 8080
  },
  host: {
    type: 'string',
    default: 'localhost'
  }
}, parsedTokens)

values.port // 3000
values.host // 'localhost'

explicit.port // true (explicitly provided)
explicit.host // false (not provided, fallback to default)