Class ChannelArgument<E>

Type Parameters

E extends boolean = false

Hierarchy (View Summary, Expand)

EntityArgument<If<E, GuildBasedChannel, GuildBasedChannel | null>>
- ChannelArgument

Constructors

constructor

new ChannelArgument<E extends boolean = false>(
    context: Context,
    commandContent: string,
    argv: string[],
    value: string,
    position: number,
    name?: string,
    rules?: Partial<ArgumentRules>,
    interaction?: ChatInputCommandInteraction<CacheType>,
): ChannelArgument<E>
Type Parameters
- E extends boolean = false
Parameters
- context: Context
- commandContent: string
- argv: string[]
- value: string
- position: number
- Optionalname: string
- Optionalrules: Partial<ArgumentRules>
- Optionalinteraction: ChatInputCommandInteraction<CacheType>
Returns ChannelArgument<E>
Inherited from EntityArgument.constructor
- Defined in src/framework/typescript/arguments/Argument.ts:48

Properties

`Readonly`abortAfterParsing

abortAfterParsing: boolean = false

`Protected` `Readonly`argv

argv: string[]

`Protected` `Readonly`commandContent

commandContent: string

`Protected` `Readonly`context

context: Context

`Protected` `Optional` `Readonly`interaction

interaction?: ChatInputCommandInteraction<CacheType>

`Protected`isRequired

isRequired: boolean = false

`Protected` `Readonly`mentionStart

mentionStart: string[] = ...

`Optional` `Readonly`name

name?: string

`Readonly`position

position: number

`Protected` `Optional` `Readonly`rules

rules?: Partial<ArgumentRules>

`Protected` `Readonly`stringValue

stringValue: string

`Protected`transformedValue

transformedValue: If

`Static` `Readonly`defaultErrors

defaultErrors: { EntityNotFound: string; InvalidType: string; Required: string } = ...

Methods

`Protected`attemptValidation

attemptValidation(): Awaitable<boolean>
Returns Awaitable<boolean>
Inherited from EntityArgument.attemptValidation
- Defined in src/framework/typescript/arguments/Argument.ts:153

`Protected`error

error(
    message: string,
    type: ErrorType,
    ruleLike?: string | { message?: string },
): never
Parameters
- message: string
- type: ErrorType
- OptionalruleLike: string | { message?: string }
Returns never
Inherited from EntityArgument.error
- Defined in src/framework/typescript/arguments/Argument.ts:140

getRawValue

getRawValue(): string
Returns string
Inherited from EntityArgument.getRawValue
- Defined in src/framework/typescript/arguments/Argument.ts:132

getValue

getValue(): If<E, GuildBasedChannel, null | GuildBasedChannel>
Returns If<E, GuildBasedChannel, null | GuildBasedChannel>
Inherited from EntityArgument.getValue
- Defined in src/framework/typescript/arguments/Argument.ts:136

postTransformValidation

postTransformValidation(): boolean
Returns boolean
Overrides EntityArgument.postTransformValidation
- Defined in src/framework/typescript/arguments/ChannelArgument.ts:60

`Protected`resolveFromInteraction

resolveFromInteraction(
interaction: ChatInputCommandInteraction,
): Awaitable<GuildBasedChannel>
Parameters
- interaction: ChatInputCommandInteraction
Returns Awaitable<GuildBasedChannel>
Overrides EntityArgument.resolveFromInteraction
- Defined in src/framework/typescript/arguments/ChannelArgument.ts:68

setRequired

setRequired(isRequired: boolean): ChannelArgument<E>
Parameters
- isRequired: boolean
Returns ChannelArgument<E>
Inherited from EntityArgument.setRequired
- Defined in src/framework/typescript/arguments/Argument.ts:67

`Protected`transform

transform(): Promise<If<E, GuildBasedChannel, null | GuildBasedChannel>>
Returns Promise<If<E, GuildBasedChannel, null | GuildBasedChannel>>
Overrides EntityArgument.transform
- Defined in src/framework/typescript/arguments/ChannelArgument.ts:45

validate

validate(): boolean
Returns boolean
Overrides EntityArgument.validate
- Defined in src/framework/typescript/arguments/ChannelArgument.ts:41

`Static`castFrom

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>
Inherited from EntityArgument.castFrom
- Defined in src/framework/typescript/arguments/Argument.ts:209

`Static`performCast

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>>
Inherited from EntityArgument.performCast
- Defined in src/framework/typescript/arguments/Argument.ts:164

`Static`performCastFromInteraction

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 },
>
Inherited from EntityArgument.performCastFromInteraction
- Defined in src/framework/typescript/arguments/Argument.ts:82

Class ChannelArgument<E>

Type Parameters

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ChannelArgument<E>

Properties

ReadonlyabortAfterParsing

Protected Readonlyargv

Protected ReadonlycommandContent

Protected Readonlycontext

Protected Optional Readonlyinteraction

ProtectedisRequired

Protected ReadonlymentionStart

Optional Readonlyname

Readonlyposition

Protected Optional Readonlyrules

Protected ReadonlystringValue

ProtectedtransformedValue

Static ReadonlydefaultErrors

Methods

ProtectedattemptValidation

Returns Awaitable<boolean>

Protectederror

Parameters

Returns never

getRawValue

Returns string

getValue

Returns If<E, GuildBasedChannel, null | GuildBasedChannel>

postTransformValidation

Returns boolean

ProtectedresolveFromInteraction

Parameters

Returns Awaitable<GuildBasedChannel>

setRequired

Parameters

Returns ChannelArgument<E>

toSnowflake

Returns string

toString

Returns string

toTransformed

Returns Promise<ChannelArgument<E>>

Protectedtransform

Returns Promise<If<E, GuildBasedChannel, null | GuildBasedChannel>>

validate

Returns boolean

StaticcastFrom

Parameters

Returns argument<unknown>

StaticperformCast

Parameters

Returns Promise<Casted<unknown>>

StaticperformCastFromInteraction

Parameters

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

Settings

On This Page

`Readonly`abortAfterParsing

`Protected` `Readonly`argv

`Protected` `Readonly`commandContent

`Protected` `Readonly`context

`Protected` `Optional` `Readonly`interaction

`Protected`isRequired

`Protected` `Readonly`mentionStart

`Optional` `Readonly`name

`Readonly`position

`Protected` `Optional` `Readonly`rules

`Protected` `Readonly`stringValue

`Protected`transformedValue

`Static` `Readonly`defaultErrors

`Protected`attemptValidation

`Protected`error

`Protected`resolveFromInteraction

`Protected`transform

`Static`castFrom

`Static`performCast

`Static`performCastFromInteraction

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