Results

Namespace

Type

Hierarchy

  • ICommandArgs <-- You are here!

Index

Methods

guildChannel

guildChannelOptional

guildMember

guildMemberOptional

  • guildMemberOptional(options?: IArgumentOptions): Promise<GuildMember | null>
  • Optionally parses a mention string or user id and resolves a discord.GuildMember object reference. If the argument is present but the member was not found, the command will error. Like all optional arguments, if the argument is not present the value will be resolved as null.

    Parameters

    Returns Promise<GuildMember | null>

guildTextChannel

guildTextChannelOptional

guildVoiceChannel

guildVoiceChannelOptional

integer

integerOptional

number

numberOptional

string

stringList

  • stringList(options?: IArgumentOptions): string[]
  • Parses the rest of the command's input as space-delimited string values. If used, this argument must appear as the last argument in your command handler.

    Parameters

    Returns string[]

stringListOptional

  • stringListOptional(options: IOptionalArgumentOptions<string[]>): string[]
  • Optionally parses the rest of the command's input as space-delimited string values. If used, this argument must appear as the last argument in your command handler.

    Parameters

    Returns string[]

  • stringListOptional(options?: IArgumentOptions): string[] | null
  • Parameters

    Returns string[] | null

stringOptional

text

  • text(options?: IArgumentOptions): string
  • Parses the rest of the command's input as a string, leaving no more content for any future arguments. If used, this argument must appear as the last argument in your command handler.

    Parameters

    Returns string

textOptional

  • textOptional(options: IOptionalArgumentOptions<string>): string
  • Optionally parses the rest of the command's input as a string, leaving no more content for any future arguments. If used, this argument must appear as the last argument in your command handler.

    Parameters

    Returns string

  • textOptional(options?: IArgumentOptions): string | null
  • Parameters

    Returns string | null

user

  • user(options?: IArgumentOptions): Promise<User>
  • Parses a mention string or user id and resolves a discord.User object reference. If the user was not found, the command will error.

    Parameters

    Returns Promise<User>

userOptional

  • userOptional(options?: IArgumentOptions): Promise<User | null>
  • Optionally parses a mention string or user id and resolves a discord.User object reference. If the argument is present but the user was not found, the command will error. Like all optional arguments, if the argument is not present the value will be resolved as null.

    Parameters

    Returns Promise<User | null>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc