Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional defaultValue

defaultValue?: string

If not specified defaults to the empty string for both String and Path.

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 | Path

Specifies the resolution strategy. If Path is provided, values will be resolved according to their location in a file. If String or no value is provided, values will not be resolved.

Methods

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.

    Parameters

    • value: string

    Returns void

Generated using TypeDoc