Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PositionalOptions

Index

Properties

Optional alias

alias: string | readonly string[]

string or array of strings, see alias()

Optional array

array: boolean

boolean, interpret option as an array, see array()

Optional choices

choices: Choices

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

Optional coerce

coerce: (arg: any) => any

Type declaration

    • (arg: any): any
    • function, coerce or transform parsed command line values into another value, see coerce()

      Parameters

      • arg: any

      Returns any

Optional conflicts

conflicts: string | readonly 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 demandOption

demandOption: string | boolean

boolean or string, demand the option be given, with optional error message, see demandOption()

Optional desc

desc: string

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

Optional describe

describe: string

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

Optional description

description: string

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

Optional implies

implies: string | readonly string[] | {}

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

Optional normalize

normalize: boolean

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

Optional type