Interface ICliCommandPropertyArgumentMetadata

Command argument definition config.

interface ICliCommandPropertyArgumentMetadata {
    default?: (() => any);
    description?: string;
    index: number;
    method: string;
    name: string;
    parser?: ((value) => any);
    position: number;
    required?: boolean;
    type: "argument";
}

Hierarchy (view full)

Properties

default? description? index method name parser? position required? type

Properties

Optional default

default?: (() => any)

Argument default value factory function.

Type declaration

    • (): any

    • Returns any

Optional description

description?: string

Argument description.

index

index: number

method

method: string

name

name: string

Argument name.

Optional parser

parser?: ((value) => any)

Optional argument value parser.

Type declaration

    • (value): any

    • Parameters

      • value: string

      Returns any

position

position: number

Argument position in the command. Will be used during the command parsing. Starts from 0.

Optional required

required?: boolean

Is argument required.

type

type: "argument"

Settings

Member Visibility

Theme

On This Page

defaultdescriptionindexmethodnameparserpositionrequiredtype