Interface IArg<Type, Required, Rest, Enum>

interface IArg {
    check?: ((i) => boolean);
    condition?: boolean;
    delimiter?: string;
    description: string;
    enum?: Enum;
    name: string;
    pointer?: number;
    pointerProperty?: string;
    required?: Required;
    rest: Rest;
    type: Type;
}

Type Parameters

Properties

check? condition? delimiter? description enum? name pointer? pointerProperty? required? rest type

Properties

Optional check

check?: ((i) => boolean)

Type declaration

    • (i): boolean

    • Parameters

      Returns boolean

Optional condition

condition?: boolean

Optional delimiter

delimiter?: string

description

description: string

Optional enum

enum?: Enum

name

name: string

Optional pointer

pointer?: number

Arg index to look at when a type requires a previously guild arg or depends on something.

Optional pointerProperty

pointerProperty?: string

Optional required

required?: Required

Defaults to false

rest

rest: Rest

Whether this argument is an array of values

type

type: Type

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc