Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptionDef

Defines a command-line option.

Hierarchy

  • IOptionDef

Index

Properties

Optional alias

alias: undefined | string

An alias for the option name. Parsed as -n

Optional defaultValue

defaultValue: any

Default value of this option.

name

name: string

The name of the option. Parsed as --name

Optional switch

switch: undefined | false | true

Whether or not this option is a switch and takes no argument.

type

type: "number" | "string" | "boolean" | "json"

The type of this option. When parsed, it will return the value as this type.

Generated using TypeDoc