Class Argument

Represents an argument for a command.

Index

Constructors

constructor

new Argument(command: Command, options?: ArgumentOptions): Argument
Parameters
- command: Command
  Command of the argument.
- options: ArgumentOptions = {}
  Options for the argument.
Returns Argument
- Defined in src/struct/commands/arguments/Argument.ts:147

Properties

command

command: Command

The command this argument belongs to.

default

default: any

The default value of the argument or a function supplying the default value.

description

description: any

Description of the command.

flag

flag: null | string | string[]

The string(s) to use for flag or option match.

index

index: null | number

The index to start from.

limit

limit: number

The amount of phrases to match for rest, separate, content, or text match.

match

The method to match text.

modifyOtherwise

modifyOtherwise: null | OtherwiseContentModifier

Function to modify otherwise content.

multipleFlags

multipleFlags: boolean

Whether to process multiple option flags instead of just the first.

otherwise

otherwise:
    | null
    | MessageSendResolvable
    | (
        (
            ...args: [message: TextCommandMessage, data: FailureData],
        ) => SyncOrAsync
    )

The content or function supplying the content sent when argument parsing fails.

prompt

prompt: null | boolean | ArgumentPromptOptions

The prompt options.

type

type:
| ArgumentType
| ((...args: [message: TextCommandMessage, phrase: string]) => unknown)

The type to cast to or a function to use to cast.

unordered

unordered: number | boolean | number[]

Whether or not the argument is unordered.

Accessors

client

get client(): AkairoClient
The client.

Returns AkairoClient
- Defined in src/struct/commands/arguments/Argument.ts:181

handler

get handler(): CommandHandler
The command handler.

Returns CommandHandler
- Defined in src/struct/commands/arguments/Argument.ts:188

Methods

cast

cast(message: TextCommandMessage, phrase: string): Promise<any>
Casts a phrase to this argument's type.
Parameters
- message: TextCommandMessage
  Message that called the command.
- phrase: string
  Phrase to process.
Returns Promise<any>
- Defined in src/struct/commands/arguments/Argument.ts:197

collect

collect(
    message: TextCommandMessage,
    commandInput?: string,
    parsedInput?: any,
): Promise<any>
Collects input from the user by prompting.
Parameters
- message: TextCommandMessage
  Message to prompt.
- commandInput: string = ""
  Previous input from command if there was one.
- parsedInput: any = null
  Previous parsed input from command if there was one.
Returns Promise<any>
- Defined in src/struct/commands/arguments/Argument.ts:207

process

process(message: TextCommandMessage, phrase: string): Promise<any>
Processes the type casting and prompting of the argument for a phrase.
Parameters
- message: TextCommandMessage
  The message that called the command.
- phrase: string
  The phrase to process.
Returns Promise<any>
- Defined in src/struct/commands/arguments/Argument.ts:375

`Static`cast

cast<T extends ATC<unknown>>(
    type: T,
    resolver: TypeResolver,
    message: TextCommandMessage,
    phrase: string,
): Promise<ArgumentTypeCasterReturn<T>>
Casts a phrase to this argument's type.
Type Parameters
- T extends ATC<unknown>
Parameters
- type: T
  The type to cast to.
- resolver: TypeResolver
  The type resolver.
- message: TextCommandMessage
  Message that called the command.
- phrase: string
  Phrase to process.
Returns Promise<ArgumentTypeCasterReturn<T>>
- Defined in src/struct/commands/arguments/Argument.ts:449
cast<T extends keyof BaseArgumentType>(
    type: T,
    resolver: TypeResolver,
    message: TextCommandMessage,
    phrase: string,
): Promise<BaseArgumentType[T]>
Casts a phrase to this argument's type.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- type: T
  The type to cast to.
- resolver: TypeResolver
  The type resolver.
- message: TextCommandMessage
  Message that called the command.
- phrase: string
  Phrase to process.
Returns Promise<BaseArgumentType[T]>
- Defined in src/struct/commands/arguments/Argument.ts:455
cast(
    type: ArgumentType | ATC<unknown>,
    resolver: TypeResolver,
    message: TextCommandMessage,
    phrase: string,
): Promise<any>
Casts a phrase to this argument's type.
Parameters
- type: ArgumentType | ATC<unknown>
  The type to cast to.
- resolver: TypeResolver
  The type resolver.
- message: TextCommandMessage
  Message that called the command.
- phrase: string
  Phrase to process.
Returns Promise<any>
- Defined in src/struct/commands/arguments/Argument.ts:461

`Static`compose

compose<T extends ATC<unknown>>(...types: T[]): ATCATCR<T>
Creates a type that is the left-to-right composition of the given types. If any of the types fails, the entire composition fails.
Type Parameters
- T extends ATC<unknown>
Parameters
- ...types: T[]
  Types to use.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:514
compose<T extends keyof BaseArgumentType>(...types: T[]): ATCBAT<T>
Creates a type that is the left-to-right composition of the given types. If any of the types fails, the entire composition fails.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- ...types: T[]
  Types to use.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:515
compose(...types: (ArgumentType | ATC<unknown>)[]): ATC
Creates a type that is the left-to-right composition of the given types. If any of the types fails, the entire composition fails.
Parameters
- ...types: (ArgumentType | ATC<unknown>)[]
  Types to use.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:516

`Static`composeWithFailure

composeWithFailure<T extends ATC<unknown>>(...types: T[]): ATCATCR<T>
Creates a type that is the left-to-right composition of the given types. If any of the types fails, the composition still continues with the failure passed on.
Type Parameters
- T extends ATC<unknown>
Parameters
- ...types: T[]
  Types to use.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:535
composeWithFailure<T extends keyof BaseArgumentType>(...types: T[]): ATCBAT<T>
Creates a type that is the left-to-right composition of the given types. If any of the types fails, the composition still continues with the failure passed on.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- ...types: T[]
  Types to use.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:536
composeWithFailure(...types: (ArgumentType | ATC<unknown>)[]): ATC
Creates a type that is the left-to-right composition of the given types. If any of the types fails, the composition still continues with the failure passed on.
Parameters
- ...types: (ArgumentType | ATC<unknown>)[]
  Types to use.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:537

`Static`isFailure

isFailure(value: unknown): value is undefined | null | Flag<Fail>
Checks if something is null, undefined, or a fail flag.
Parameters
- value: unknown
  Value to check.
Returns value is undefined | null | Flag<Fail>
- Defined in src/struct/commands/arguments/Argument.ts:554

`Static`product

product<T extends ATC<unknown>>(...types: T[]): ATCATCR<T>
Creates a type from multiple types (product type). Only inputs where each type resolves with a non-void value are valid.
Type Parameters
- T extends ATC<unknown>
Parameters
- ...types: T[]
  Types to use.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:563
product<T extends keyof BaseArgumentType>(...types: T[]): ATCBAT<T>
Creates a type from multiple types (product type). Only inputs where each type resolves with a non-void value are valid.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- ...types: T[]
  Types to use.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:564
product(...types: (ArgumentType | ATC<unknown>)[]): ATC
Creates a type from multiple types (product type). Only inputs where each type resolves with a non-void value are valid.
Parameters
- ...types: (ArgumentType | ATC<unknown>)[]
  Types to use.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:565

`Static`range

range<T extends ATC<unknown>>(
    type: T,
    min: number,
    max: number,
    inclusive?: boolean,
): ATCATCR<T>
Creates a type where the parsed value must be within a range.
Type Parameters
- T extends ATC<unknown>
Parameters
- type: T
  The type to use.
- min: number
  Minimum value.
- max: number
  Maximum value.
- Optionalinclusive: boolean
  Whether or not to be inclusive on the upper bound.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:587
range<T extends keyof BaseArgumentType>(
    type: T,
    min: number,
    max: number,
    inclusive?: boolean,
): ATCBAT<T>
Creates a type where the parsed value must be within a range.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- type: T
  The type to use.
- min: number
  Minimum value.
- max: number
  Maximum value.
- Optionalinclusive: boolean
  Whether or not to be inclusive on the upper bound.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:588
range(
    type: ArgumentType | ATC<unknown>,
    min: number,
    max: number,
    inclusive?: boolean,
): ATC
Creates a type where the parsed value must be within a range.
Parameters
- type: ArgumentType | ATC<unknown>
  The type to use.
- min: number
  Minimum value.
- max: number
  Maximum value.
- Optionalinclusive: boolean
  Whether or not to be inclusive on the upper bound.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:589

`Static`tagged

tagged<T extends ATC<unknown>>(type: T, tag?: any): ATCATCR<T>
Creates a type that parses as normal but also tags it with some data. Result is in an object { tag, value } and wrapped in Flag.fail when failed.
Type Parameters
- T extends ATC<unknown>
Parameters
- type: T
  The type to use.
- Optionaltag: any
  Tag to add. Defaults to the type argument, so useful if it is a string.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:604
tagged<T extends keyof BaseArgumentType>(type: T, tag?: any): ATCBAT<T>
Creates a type that parses as normal but also tags it with some data. Result is in an object { tag, value } and wrapped in Flag.fail when failed.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- type: T
  The type to use.
- Optionaltag: any
  Tag to add. Defaults to the type argument, so useful if it is a string.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:605
tagged(type: ArgumentType | ATC<unknown>, tag?: any): ATC
Creates a type that parses as normal but also tags it with some data. Result is in an object { tag, value } and wrapped in Flag.fail when failed.
Parameters
- type: ArgumentType | ATC<unknown>
  The type to use.
- Optionaltag: any
  Tag to add. Defaults to the type argument, so useful if it is a string.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:606

`Static`taggedUnion

taggedUnion<T extends ATC<unknown>>(...types: T[]): ATCATCR<T>
Creates a type from multiple types (union type). The first type that resolves to a non-void value is used. Each type will also be tagged using tagged with themselves.
Type Parameters
- T extends ATC<unknown>
Parameters
- ...types: T[]
  Types to use.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:625
taggedUnion<T extends keyof BaseArgumentType>(...types: T[]): ATCBAT<T>
Creates a type from multiple types (union type). The first type that resolves to a non-void value is used. Each type will also be tagged using tagged with themselves.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- ...types: T[]
  Types to use.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:626
taggedUnion(...types: (ArgumentType | ATC<unknown>)[]): ATC
Creates a type from multiple types (union type). The first type that resolves to a non-void value is used. Each type will also be tagged using tagged with themselves.
Parameters
- ...types: (ArgumentType | ATC<unknown>)[]
  Types to use.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:627

`Static`taggedWithInput

taggedWithInput<T extends ATC<unknown>>(type: T, tag?: any): ATCATCR<T>
Creates a type that parses as normal but also tags it with some data and carries the original input. Result is in an object { tag, input, value } and wrapped in Flag.fail when failed.
Type Parameters
- T extends ATC<unknown>
Parameters
- type: T
  The type to use.
- Optionaltag: any
  Tag to add. Defaults to the type argument, so useful if it is a string.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:646
taggedWithInput<T extends keyof BaseArgumentType>(type: T, tag?: any): ATCBAT<T>
Creates a type that parses as normal but also tags it with some data and carries the original input. Result is in an object { tag, input, value } and wrapped in Flag.fail when failed.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- type: T
  The type to use.
- Optionaltag: any
  Tag to add. Defaults to the type argument, so useful if it is a string.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:647
taggedWithInput(type: ArgumentType | ATC<unknown>, tag?: any): ATC
Creates a type that parses as normal but also tags it with some data and carries the original input. Result is in an object { tag, input, value } and wrapped in Flag.fail when failed.
Parameters
- type: ArgumentType | ATC<unknown>
  The type to use.
- Optionaltag: any
  Tag to add. Defaults to the type argument, so useful if it is a string.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:648

`Static`union

union<T extends ATC<unknown>>(...types: T[]): ATCATCR<T>
Creates a type from multiple types (union type). The first type that resolves to a non-void value is used.
Type Parameters
- T extends ATC<unknown>
Parameters
- ...types: T[]
  Types to use.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:666
union<T extends keyof BaseArgumentType>(...types: T[]): ATCBAT<T>
Creates a type from multiple types (union type). The first type that resolves to a non-void value is used.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- ...types: T[]
  Types to use.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:667
union(...types: (ArgumentType | ATC<unknown>)[]): ATC
Creates a type from multiple types (union type). The first type that resolves to a non-void value is used.
Parameters
- ...types: (ArgumentType | ATC<unknown>)[]
  Types to use.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:668

`Static`validate

validate<T extends ATC<unknown>>(
type: T,
predicate: ParsedValuePredicate,
): ATCATCR<T>
Creates a type with extra validation. If the predicate is not true, the value is considered invalid.
Type Parameters
- T extends ATC<unknown>
Parameters
- type: T
  The type to use.
- predicate: ParsedValuePredicate
  The predicate function.
Returns ATCATCR<T>
- Defined in src/struct/commands/arguments/Argument.ts:687
validate<T extends keyof BaseArgumentType>(
type: T,
predicate: ParsedValuePredicate,
): ATCBAT<T>
Creates a type with extra validation. If the predicate is not true, the value is considered invalid.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- type: T
  The type to use.
- predicate: ParsedValuePredicate
  The predicate function.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:688
validate(
type: ArgumentType | ATC<unknown>,
predicate: ParsedValuePredicate,
): ATC
Creates a type with extra validation. If the predicate is not true, the value is considered invalid.
Parameters
- type: ArgumentType | ATC<unknown>
  The type to use.
- predicate: ParsedValuePredicate
  The predicate function.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:689

`Static`withInput

withInput<T extends ATC<unknown>>(type: T): ATC<ArgumentTypeCasterReturn<T>>
Creates a type that parses as normal but also carries the original input. Result is in an object { input, value } and wrapped in Flag.fail when failed.
Type Parameters
- T extends ATC<unknown>
Parameters
- type: T
  The type to use.
Returns ATC<ArgumentTypeCasterReturn<T>>
- Defined in src/struct/commands/arguments/Argument.ts:705
withInput<T extends keyof BaseArgumentType>(type: T): ATCBAT<T>
Creates a type that parses as normal but also carries the original input. Result is in an object { input, value } and wrapped in Flag.fail when failed.
Type Parameters
- T extends keyof BaseArgumentType
Parameters
- type: T
  The type to use.
Returns ATCBAT<T>
- Defined in src/struct/commands/arguments/Argument.ts:706
withInput(type: ArgumentType | ATC<unknown>): ATC
Creates a type that parses as normal but also carries the original input. Result is in an object { input, value } and wrapped in Flag.fail when failed.
Parameters
- type: ArgumentType | ATC<unknown>
  The type to use.
Returns ATC
- Defined in src/struct/commands/arguments/Argument.ts:707

Class Argument

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Argument

Properties

command

default

description

flag

index

limit

match

modifyOtherwise

multipleFlags

otherwise

prompt

type

unordered

Accessors

client

Returns AkairoClient

handler

Returns CommandHandler

Methods

cast

Parameters

Returns Promise<any>

collect

Parameters

Returns Promise<any>

process

Parameters

Returns Promise<any>

Staticcast

Type Parameters

Parameters

Returns Promise<ArgumentTypeCasterReturn<T>>

Type Parameters

Parameters

Returns Promise<BaseArgumentType[T]>

Parameters

Returns Promise<any>

Staticcompose

Type Parameters

Parameters

Returns ATCATCR<T>

Type Parameters

Parameters

Returns ATCBAT<T>

Parameters

Returns ATC

StaticcomposeWithFailure

Type Parameters

Parameters

Returns ATCATCR<T>

Type Parameters

Parameters

Returns ATCBAT<T>

Parameters

Returns ATC

StaticisFailure

Parameters

Returns value is undefined | null | Flag<Fail>

Staticproduct

Type Parameters

Parameters

Returns ATCATCR<T>

Type Parameters

Parameters

Returns ATCBAT<T>

Parameters

Returns ATC

Staticrange

Type Parameters

`Static`cast

`Static`compose

`Static`composeWithFailure

`Static`isFailure

`Static`product

`Static`range

`Static`tagged

`Static`taggedUnion

`Static`taggedWithInput

`Static`union

`Static`validate

`Static`withInput