Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OptionDeclaration

Runtime structure describing a configuration option. Used by option parsing and validation.

Hierarchy

  • OptionDeclaration

Index

Constructors

constructor

Properties

Optional component

component: undefined | string

defaultValue

defaultValue: any

help

help: string

Optional hint

Protected Optional map

map: object | "object"

Optional mapError

mapError: undefined | string

name

name: string

scope

scope: ParameterScope = ParameterScope.TypeDoc

Optional short

short: undefined | string

type

type: ParameterType = ParameterType.String

Methods

convert

  • convert(value: unknown, errorCallback?: undefined | function): any
  • Parameters

    • value: unknown

      the value the user passed in

    • Optional errorCallback: undefined | function

    Returns any

getNames

  • getNames(): string[]

Generated using TypeDoc