Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StringDeclarationOption

Hierarchy

Index

Properties

Optional defaultValue

defaultValue: string

If not specified defaults to the empty string.

help

help: string

The help text to be displayed to the user when --help is passed.

Optional hint

An optional hint for the type of input expected, will be displayed in the help output.

name

name: string

The option name.

Optional type

type: String

The parameter type, used to convert user configuration values into the expected type. If not set, the type will be a string.

Optional validate

validate: (value: string) => void

An optional validation function that validates a potential value of this option. The function must throw an Error if the validation fails and should do nothing otherwise.

Type declaration

    • (value: string): void
    • Parameters

      • value: string

      Returns void

Generated using TypeDoc