Class EntityArgument<E>Abstract

Type Parameters

  • E extends User | GuildMember | GuildBasedChannel | Role | null

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

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

Methods

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

Constructors

constructor

  • new EntityArgument<
        E extends null
        | GuildBasedChannel
        | GuildMember
        | Role
        | User,
    >(
        context: Context,
        commandContent: string,
        argv: string[],
        value: string,
        position: number,
        name?: string,
        rules?: Partial<ArgumentRules>,
        interaction?: ChatInputCommandInteraction<CacheType>,
    ): EntityArgument<E>

    Type Parameters

    • E extends null | GuildBasedChannel | GuildMember | Role | User

    Parameters

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

    Returns EntityArgument<E>

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

Protected ReadonlymentionStart

mentionStart: string[] = []

Optional Readonlyname

name?: string

Readonlyposition

position: number

Protected Optional Readonlyrules

rules?: Partial<ArgumentRules>

Protected ReadonlystringValue

stringValue: string

ProtectedtransformedValue

transformedValue: E

Methods

ProtectedattemptValidation

Protectederror

getRawValue

getValue

postTransformValidation

Protected AbstractresolveFromInteraction

setRequired

toSnowflake

toString

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