Interface IArg<Type, Required, Rest, Enum>

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

Type Parameters

Type extends ArgType = ArgType
Required extends boolean = boolean
Rest extends boolean = boolean
Enum extends EnumLike = EnumLike

Index

Properties

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

Properties

`Optional`check

check?: (i: GetArgType<Type, Enum>) => 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