Interface ICliCommandPropertyOptionMetadata

Command option definition config.

interface ICliCommandPropertyOptionMetadata {
    default?: (() => any);
    description?: string;
    method: string;
    name: string;
    parser?: ((value) => any);
    required?: boolean;
    shortName?: string;
    type: "option";
}

Hierarchy (view full)

Properties

default? description? method name parser? required? shortName? type

Properties

Optional default

default?: (() => any)

Option default value factory function.

Type declaration

    • (): any

    • Returns any

Optional description

description?: string

Option description. Will be used in the help message.

method

method: string

name

name: string

Option name. Will be used during the command parsing as --name.

Optional parser

parser?: ((value) => any)

Optional option value parser.

Type declaration

    • (value): any

    • Parameters

      • value: string

      Returns any

Optional required

required?: boolean

Is option required.

Optional shortName

shortName?: string

Option short name. Will be used during the command parsing as -n.

type

type: "option"

Settings

Member Visibility

Theme

On This Page

defaultdescriptionmethodnameparserrequiredshortNametype