Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PositionalOptions

Hierarchy

  • PositionalOptions

Index

Properties

Optional alias

alias: string | ReadonlyArray<string>

string or array of strings, see alias()

Optional choices

choices: Choices

value or array of values, limit valid option arguments to a predefined set, see choices()

Optional coerce

coerce: undefined | ((arg: any) => any)

function, coerce or transform parsed command line values into another value, see coerce()

Optional conflicts

conflicts: string | ReadonlyArray<string> | {}

string or object, require certain keys not to be set, see conflicts()

Optional default

default: any

value, set a default value for the option, see default()

Optional desc

desc: undefined | string

string, the option description for help content, see describe()

Optional describe

describe: undefined | string

string, the option description for help content, see describe()

Optional description

description: undefined | string

string, the option description for help content, see describe()

Optional implies

implies: string | ReadonlyArray<string> | {}

string or object, require certain keys to be set, see implies()

Optional normalize

normalize: undefined | false | true

boolean, apply path.normalize() to the option, see normalize()

Optional type