Class CommandArgument<T>

Type Parameters

  • T

Constructors

constructor

Properties

coalescing defaultValue description index name optional parse type validate

Accessors

isSimple isSkipable

Constructors

constructor

  • new CommandArgument<T>(name, index, argument): CommandArgument<T>

  • Type Parameters

    • T

    Parameters

    • name: string
    • index: number
    • argument: Argument<T>

    Returns CommandArgument<T>

Properties

coalescing

coalescing: boolean

Does the argument can take multiple words.

defaultValue

defaultValue: undefined | T

The default value of the argument.

description

description: string

The description of the argument, currently not used anywhere.

index

index: number

name

name: string

optional

optional: boolean

Is the argument optional or not.

parse

parse: ArgumentParser<T>

The parse function of the argument.

type

type: ArgumentType

The type of the argument.

validate

validate: ArgumentValidator

The validate function of the argument.

Accessors

isSimple

  • get isSimple(): boolean

  • Is the argument not optional, doesn't have any default value and only takes one word.

    Returns boolean

    • Is the argument simple.

isSkipable

  • get isSkipable(): boolean

  • Is the argument optional or has a default value.

    Returns boolean

    • Does the argument can be skipped.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc