Interface Options

interface Options {
    alias?: string | readonly string[];
    array?: boolean;
    boolean?: boolean;
    choices?: Choices;
    coerce?: ((arg: any) => any);
    config?: boolean;
    configParser?: ((configPath: string) => object);
    conflicts?: string | readonly string[] | {
        [key: string]: string | readonly string[];
    };
    count?: boolean;
    default?: any;
    defaultDescription?: string;
    demand?: string | boolean;
    demandOption?: string | boolean;
    deprecate?: string | boolean;
    deprecated?: string | boolean;
    desc?: string;
    describe?: string;
    description?: string;
    global?: boolean;
    group?: string;
    hidden?: boolean;
    implies?: string | readonly string[] | {
        [key: string]: string | readonly string[];
    };
    nargs?: number;
    normalize?: boolean;
    number?: boolean;
    require?: string | boolean;
    required?: string | boolean;
    requiresArg?: boolean;
    skipValidation?: boolean;
    string?: boolean;
    type?: "array" | "count" | PositionalOptionsType;
}

Properties

alias? array? boolean? choices? coerce? config? configParser? conflicts? count? default? defaultDescription? demand? demandOption? deprecate? deprecated? desc? describe? description? global? group? hidden? implies? nargs? normalize? number? require? required? requiresArg? skipValidation? string? type?

Properties

Optionalalias

alias?: string | readonly string[]

string or array of strings, alias(es) for the canonical option key, see alias()

Optionalarray

array?: boolean

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

Optionalboolean

boolean?: boolean

boolean, interpret option as a boolean flag, see boolean()

Optionalchoices

choices?: Choices

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

Optionalcoerce

coerce?: ((arg: any) => any)

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

Optionalconfig

config?: boolean

boolean, interpret option as a path to a JSON config file, see config()

OptionalconfigParser

configParser?: ((configPath: string) => object)

function, provide a custom config parsing function, see config()

Optionalconflicts

conflicts?: string | readonly string[] | {
    [key: string]: string | readonly string[];
}

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

Optionalcount

count?: boolean

boolean, interpret option as a count of boolean flags, see count()

Optionaldefault

default?: any

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

OptionaldefaultDescription

defaultDescription?: string

string, use this description for the default value in help content, see default()

Optionaldemand

demand?: string | boolean

Deprecated

since version 6.6.0 Use 'demandOption' instead

OptionaldemandOption

demandOption?: string | boolean

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

Optionaldeprecate

deprecate?: string | boolean

boolean or string, mark the argument as deprecated, see deprecateOption()

Optionaldeprecated

deprecated?: string | boolean

boolean or string, mark the argument as deprecated, see deprecateOption()

Optionaldesc

desc?: string

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

Optionaldescribe

describe?: string

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

Optionaldescription

description?: string

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

Optionalglobal

global?: boolean

boolean, indicate that this key should not be reset when a command is invoked, see global()

Optionalgroup

group?: string

string, when displaying usage instructions place the option under an alternative group heading, see group()

Optionalhidden

hidden?: boolean

don't display option in help output.

Optionalimplies

implies?: string | readonly string[] | {
    [key: string]: string | readonly string[];
}

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

Optionalnargs

nargs?: number

number, specify how many arguments should be consumed for the option, see nargs()

Optionalnormalize

normalize?: boolean

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

Optionalnumber

number?: boolean

boolean, interpret option as a number, number()

Optionalrequire

require?: string | boolean

Deprecated

since version 6.6.0 Use 'demandOption' instead

Optionalrequired

required?: string | boolean

Deprecated

since version 6.6.0 Use 'demandOption' instead

OptionalrequiresArg

requiresArg?: boolean

boolean, require the option be specified with a value, see requiresArg()

OptionalskipValidation

skipValidation?: boolean

boolean, skips validation if the option is present, see skipValidation()

Optionalstring

string?: boolean

boolean, interpret option as a string, see string()

Optionaltype

type?: "array" | "count" | PositionalOptionsType

Settings

Member Visibility

On This Page

Properties