Function: resolveArgs()

Resolve command line arguments.

Signature

declare function resolveArgs<A extends Args>(args: A, tokens: ArgToken[], {
  shortGrouping,
  skipPositional,
  toKebab
}?: ResolveArgs): {
  values: ArgValues<A>;
  positionals: string[];
  rest: string[];
  error: AggregateError | undefined;
  explicit: ArgExplicitlyProvided<A>;
}

Type Parameters

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

Parameters

Name	Type	Description
args	A	An arguments that contains arguments schema.
tokens	ArgToken[]	An array of tokens.
resolveArgs	ResolveArgs	An arguments that contains resolve arguments. (optional)

Returns

object — An object that contains the values of the arguments, positional arguments, rest arguments, validation errors, and explicit provision status.

error

error: AggregateError | undefined;

explicit

explicit: ArgExplicitlyProvided<A>;

positionals

positionals: string[];

rest

rest: string[];

values

values: ArgValues<A>;

Examples

// 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)