Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional defaultValue

defaultValue?: number

If not specified defaults to 0.

help

help: string

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

Optional maxValue

maxValue?: number

Highest possible value.

Optional minValue

minValue?: number

Lowest possible value.

name

name: string

The option name.

type

type: Number

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

Methods

Optional validate

  • validate(value: number): 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: number

    Returns void

Generated using TypeDoc