Class argument<T>Abstract

Type Parameters

  • T = unknown

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties

abortAfterParsing argv commandContent context interaction? isRequired name? position rules? stringValue transformedValue

Methods

attemptValidation error getRawValue getValue postTransformValidation resolveFromInteraction setRequired toString toTransformed transform validate castFrom performCast performCastFromInteraction

Constructors

constructor

  • new argument<T = unknown>(
        context: Context,
        commandContent: string,
        argv: string[],
        value: string,
        position: number,
        name?: string,
        rules?: Partial<ArgumentRules>,
        interaction?: ChatInputCommandInteraction<CacheType>,
    ): argument<T>

    Type Parameters

    • T = unknown

    Parameters

    • context: Context
    • commandContent: string
    • argv: string[]
    • value: string
    • position: number
    • Optionalname: string
    • Optionalrules: Partial<ArgumentRules>
    • Optionalinteraction: ChatInputCommandInteraction<CacheType>

    Returns argument<T>

Properties

ReadonlyabortAfterParsing

abortAfterParsing: boolean = false

Protected Readonlyargv

argv: string[]

Protected ReadonlycommandContent

commandContent: string

Protected Readonlycontext

context: Context

Protected Optional Readonlyinteraction

interaction?: ChatInputCommandInteraction<CacheType>

ProtectedisRequired

isRequired: boolean = false

Optional Readonlyname

name?: string

Readonlyposition

position: number

Protected Optional Readonlyrules

rules?: Partial<ArgumentRules>

Protected ReadonlystringValue

stringValue: string

ProtectedtransformedValue

transformedValue: T

Methods

ProtectedattemptValidation

Protectederror

getRawValue

getValue

postTransformValidation

Protected AbstractresolveFromInteraction

setRequired

AbstracttoString

toTransformed

Protected Abstracttransform

validate

StaticcastFrom

  • castFrom(
        context: Context,
        commandContent: string,
        argv: string[],
        value: string,
        position: number,
        name?: string,
        rules?: Partial<ArgumentRules>,
        interaction?: ChatInputCommandInteraction<CacheType>,
    ): argument<unknown>

    Parameters

    • context: Context
    • commandContent: string
    • argv: string[]
    • value: string
    • position: number
    • Optionalname: string
    • Optionalrules: Partial<ArgumentRules>
    • Optionalinteraction: ChatInputCommandInteraction<CacheType>

    Returns argument<unknown>

StaticperformCast

  • performCast(
        context: Context,
        commandContent: string,
        argv: string[],
        value: string,
        position: number,
        name?: string,
        rules?: Partial<ArgumentRules>,
        isRequired?: boolean,
    ): Promise<Casted<unknown>>

    Parameters

    • context: Context
    • commandContent: string
    • argv: string[]
    • value: string
    • position: number
    • Optionalname: string
    • Optionalrules: Partial<ArgumentRules>
    • isRequired: boolean = false

    Returns Promise<Casted<unknown>>

StaticperformCastFromInteraction

  • performCastFromInteraction(
        context: Context,
        interaction: ChatInputCommandInteraction,
        name: string,
        rules?: Partial<ArgumentRules>,
        isRequired?: boolean,
    ): Promise<
        | { abort: boolean; error?: undefined; value: argument<unknown> }
        | { abort?: undefined; error: InvalidArgumentError; value?: undefined },
    >

    Parameters

    • context: Context
    • interaction: ChatInputCommandInteraction
    • name: string
    • Optionalrules: Partial<ArgumentRules>
    • isRequired: boolean = false

    Returns Promise<
        | { abort: boolean; error?: undefined; value: argument<unknown> }
        | { abort?: undefined; error: InvalidArgumentError; value?: undefined },
    >

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR