NumberDeclarationOption | TypeDoc Documentation

Hierarchy

DeclarationOptionBase
- NumberDeclarationOption

Index

Properties

defaultValue
help
maxValue
minValue
name
type
validate

Properties

Optional defaultValue

defaultValue: undefined | 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: undefined | number

Highest possible value.

Optional minValue

minValue: undefined | number

Lowest possible value.

name

name: string

The option name.

type

type: Number

Optional validate

validate: undefined | ((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.