Interface CliOptionInformation<NAME>

Generic information about a CLI option.

Type Parameters

  • NAME = string

Hierarchy

  • CliOptionInformation

Properties

default? defaultValue? description example? name signature?

Properties

Optional default

default?: string | ((configDir: string) => string)

The default value.

Optional defaultValue

defaultValue?: string | ((configDir: string) => string)

The default value for example to display relative paths in 'default' but use absolute path as 'defaultValue'.

description

description: string

The description of the option.

Optional example

example?: string

Usage example.

name

name: NAME

The name of the option.

Optional signature

signature?: CliOptionSignatureParts[]

The signature of the option.

Settings

Member Visibility

Theme

Generated using TypeDoc