Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

The client.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

allowMention

allowMention: boolean = true

If true, the bot's mention can be used as an additional prefix.

app

app: null | OAuthApplicationInfo = null

Information about the bot's OAuth application.

Optional application

application: { flags: number; id: string }

Type declaration

  • flags: number
  • id: string

bot

bot: boolean

caseSensitiveCommands

caseSensitiveCommands: boolean = false

If true, command names are case-sensitive. For example, users may use !ping and !PING interchangeably (assuming ! is a valid prefix). If false, command names in code must be all lowercase.

caseSensitivePrefix

caseSensitivePrefix: boolean = true

If true, prefix matching is case-sensitive.

channelGuildMap

channelGuildMap: {}

Type declaration

  • [s: string]: string

commands

commands: Command[] = []

A list of all loaded commands.

contextAdditions

contextAdditions: object = {}

An object of stuff to add to the context object for command functions

defaultCommand

defaultCommand: null | Command = null

The default command, executed if allowMention is true and the bot is pinged without a command

disableDefaultMessageListener

disableDefaultMessageListener: boolean = false

If true, the client does not respond to commands by default, and the user must register their own messageCreate listener, which can call processCommand to perform command handling at an arbitrary point during the handler's execution

events

events: EventListener[] = []

A list of all registered event listeners.

Optional gatewayURL

gatewayURL: string

globalCommandRequirements

globalCommandRequirements: CommandRequirements = {}

A set of requirements to check for all commands.

groupChannels

groupChannels: Collection<GroupChannel>

guildShardMap

guildShardMap: {}

Type declaration

  • [s: string]: number

guilds

guilds: Collection<Guild>

ignoreBots

ignoreBots: boolean = true

If true, messages from other bot accounts will not trigger commands.

ignoreGlobalRequirements

ignoreGlobalRequirements: boolean = false

If true, requirements set via setGlobalRequirements will be ignored. Used for debugging, probably shouldn't be used in production.

deprecated

Pass no globalCommandRequirements client option instead. See https://github.com/eritbh/yuuko/issues/89

lastConnect

lastConnect: number

lastReconnectDelay

lastReconnectDelay: number

mentionPrefixRegExp

mentionPrefixRegExp: null | RegExp = null

A regular expression which matches mention prefixes. Present after the first 'ready' event is sent.

notes

notes: {}

Type declaration

  • [s: string]: string

on

options

options: ClientOptions

prefix

prefix: string

The prefix used to trigger commands.

Optional prefixFunction

prefixFunction: PrefixFunction

A custom function that determines the command prefix per message.

presence

presence: Presence

privateChannelMap

privateChannelMap: {}

Type declaration

  • [s: string]: string

privateChannels

privateChannels: Collection<PrivateChannel>

ready

ready: boolean

reconnectAttempts

reconnectAttempts: number

relationships

relationships: Collection<Relationship>

requestHandler

requestHandler: RequestHandler

shards

shards: ShardManager

startTime

startTime: number

token

token: string

The token of the bot.

unavailableGuilds

unavailableGuilds: Collection<UnavailableGuild>

uptime

uptime: number

user

userGuildSettings

userGuildSettings: {}

Type declaration

userSettings

userSettings: UserSettings

users

voiceConnections

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

defaultPrefix

  • get defaultPrefix(): string
  • set defaultPrefix(val: string): void

eventContext

Methods

acceptInvite

addCommand

addCommandDir

  • addCommandDir(dirname: string): Client

addCommandFile

  • addCommandFile(filename: string): Client

addDir

  • addDir(dirname: string): Client
  • Load the files in a directory and attempt to add a command from each. Searches recursively through directories, but ignores files and nested directories whose names begin with a period.

    Parameters

    • dirname: string

    Returns Client

addEvent

addFile

  • addFile(filename: string): Client
  • Add a command or event exported from a file.

    Parameters

    • filename: string

    Returns Client

addGroupRecipient

  • addGroupRecipient(groupID: string, userID: string): Promise<void>
  • Parameters

    • groupID: string
    • userID: string

    Returns Promise<void>

addGuildDiscoverySubcategory

addGuildMemberRole

  • addGuildMemberRole(guildID: string, memberID: string, roleID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • memberID: string
    • roleID: string
    • Optional reason: string

    Returns Promise<void>

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): Client
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

addMessageReaction

  • addMessageReaction(channelID: string, messageID: string, reaction: string): Promise<void>
  • addMessageReaction(channelID: string, messageID: string, reaction: string, userID: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string
    • reaction: string

    Returns Promise<void>

  • deprecated

    Parameters

    • channelID: string
    • messageID: string
    • reaction: string
    • userID: string

    Returns Promise<void>

addRelationship

  • addRelationship(userID: string, block?: boolean): Promise<void>
  • Parameters

    • userID: string
    • Optional block: boolean

    Returns Promise<void>

addSelfPremiumSubscription

  • addSelfPremiumSubscription(token: string, plan: string): Promise<void>

banGuildMember

  • banGuildMember(guildID: string, userID: string, deleteMessageDays?: number, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • userID: string
    • Optional deleteMessageDays: number
    • Optional reason: string

    Returns Promise<void>

closeVoiceConnection

  • closeVoiceConnection(guildID: string): void

commandForName

  • commandForName(name: string): null | Command
  • Checks the list of registered commands and returns one whch is known by a given name. Passing an empty string will return the default command, if any.

    Parameters

    • name: string

    Returns null | Command

connect

  • connect(): Promise<void>
  • Returns Promise<void>

createChannel

createChannelInvite

createChannelWebhook

  • createChannelWebhook(channelID: string, options: { avatar?: null | string; name: string }, reason?: string): Promise<Webhook>
  • Parameters

    • channelID: string
    • options: { avatar?: null | string; name: string }
      • Optional avatar?: null | string
      • name: string
    • Optional reason: string

    Returns Promise<Webhook>

createGroupChannel

  • createGroupChannel(userIDs: string[]): Promise<GroupChannel>

createGuild

createGuildEmoji

  • createGuildEmoji(guildID: string, options: EmojiOptions, reason?: string): Promise<Emoji>

createGuildFromTemplate

  • createGuildFromTemplate(code: string, name: string, icon?: string): Promise<Guild>
  • Parameters

    • code: string
    • name: string
    • Optional icon: string

    Returns Promise<Guild>

createGuildTemplate

  • createGuildTemplate(guildID: string, name: string, description?: null | string): Promise<GuildTemplate>
  • Parameters

    • guildID: string
    • name: string
    • Optional description: null | string

    Returns Promise<GuildTemplate>

createMessage

createRole

  • Parameters

    • guildID: string
    • Optional options: Role | RoleOptions
    • Optional reason: string

    Returns Promise<Role>

crosspostMessage

deleteChannel

  • deleteChannel(channelID: string, reason?: string): Promise<void>
  • Parameters

    • channelID: string
    • Optional reason: string

    Returns Promise<void>

deleteChannelPermission

  • deleteChannelPermission(channelID: string, overwriteID: string, reason?: string): Promise<void>
  • Parameters

    • channelID: string
    • overwriteID: string
    • Optional reason: string

    Returns Promise<void>

deleteGuild

  • deleteGuild(guildID: string): Promise<void>
  • Parameters

    • guildID: string

    Returns Promise<void>

deleteGuildDiscoverySubcategory

  • deleteGuildDiscoverySubcategory(guildID: string, categoryID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • categoryID: string
    • Optional reason: string

    Returns Promise<void>

deleteGuildEmoji

  • deleteGuildEmoji(guildID: string, emojiID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • emojiID: string
    • Optional reason: string

    Returns Promise<void>

deleteGuildIntegration

  • deleteGuildIntegration(guildID: string, integrationID: string): Promise<void>
  • Parameters

    • guildID: string
    • integrationID: string

    Returns Promise<void>

deleteGuildTemplate

  • deleteGuildTemplate(guildID: string, code: string): Promise<GuildTemplate>

deleteInvite

  • deleteInvite(inviteID: string, reason?: string): Promise<void>
  • Parameters

    • inviteID: string
    • Optional reason: string

    Returns Promise<void>

deleteMessage

  • deleteMessage(channelID: string, messageID: string, reason?: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string
    • Optional reason: string

    Returns Promise<void>

deleteMessages

  • deleteMessages(channelID: string, messageIDs: string[], reason?: string): Promise<void>
  • Parameters

    • channelID: string
    • messageIDs: string[]
    • Optional reason: string

    Returns Promise<void>

deleteRole

  • deleteRole(guildID: string, roleID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • roleID: string
    • Optional reason: string

    Returns Promise<void>

deleteSelfConnection

  • deleteSelfConnection(platform: string, id: string): Promise<void>
  • Parameters

    • platform: string
    • id: string

    Returns Promise<void>

deleteSelfPremiumSubscription

  • deleteSelfPremiumSubscription(): Promise<void>

deleteUserNote

  • deleteUserNote(userID: string): Promise<void>
  • Parameters

    • userID: string

    Returns Promise<void>

deleteWebhook

  • deleteWebhook(webhookID: string, token?: string, reason?: string): Promise<void>
  • Parameters

    • webhookID: string
    • Optional token: string
    • Optional reason: string

    Returns Promise<void>

deleteWebhookMessage

  • deleteWebhookMessage(webhookID: string, token: string, messageID: string): Promise<void>
  • Parameters

    • webhookID: string
    • token: string
    • messageID: string

    Returns Promise<void>

disableSelfMFATOTP

  • disableSelfMFATOTP(code: string): Promise<{ token: string }>
  • Parameters

    • code: string

    Returns Promise<{ token: string }>

disconnect

  • disconnect(options: { reconnect?: boolean | "auto" }): void
  • Parameters

    • options: { reconnect?: boolean | "auto" }
      • Optional reconnect?: boolean | "auto"

    Returns void

editAFK

  • editAFK(afk: boolean): void
  • Parameters

    • afk: boolean

    Returns void

editChannel

editChannelPermission

  • editChannelPermission(channelID: string, overwriteID: string, allow: number | bigint, deny: number | bigint, type: string, reason?: string): Promise<void>
  • Parameters

    • channelID: string
    • overwriteID: string
    • allow: number | bigint
    • deny: number | bigint
    • type: string
    • Optional reason: string

    Returns Promise<void>

editChannelPosition

editGuild

  • Parameters

    • guildID: string
    • options: GuildOptions
    • Optional reason: string

    Returns Promise<Guild>

editGuildDiscovery

editGuildEmoji

  • editGuildEmoji(guildID: string, emojiID: string, options: { name?: string; roles?: string[] }, reason?: string): Promise<Emoji>
  • Parameters

    • guildID: string
    • emojiID: string
    • options: { name?: string; roles?: string[] }
      • Optional name?: string
      • Optional roles?: string[]
    • Optional reason: string

    Returns Promise<Emoji>

editGuildIntegration

  • editGuildIntegration(guildID: string, integrationID: string, options: IntegrationOptions): Promise<void>

editGuildMember

  • editGuildMember(guildID: string, memberID: string, options: MemberOptions, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • memberID: string
    • options: MemberOptions
    • Optional reason: string

    Returns Promise<void>

editGuildTemplate

editGuildVanity

  • editGuildVanity(guildID: string, code: null | string): Promise<GuildVanity>
  • Parameters

    • guildID: string
    • code: null | string

    Returns Promise<GuildVanity>

editGuildVoiceState

  • editGuildVoiceState(guildID: string, options: VoiceStateOptions, userID?: string): Promise<void>

editGuildWelcomeScreen

editGuildWidget

  • editGuildWidget(guildID: string, options: Widget): Promise<Widget>

editMessage

editNickname

  • editNickname(guildID: string, nick: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • nick: string
    • Optional reason: string

    Returns Promise<void>

editRole

  • editRole(guildID: string, roleID: string, options: RoleOptions, reason?: string): Promise<Role>
  • Parameters

    • guildID: string
    • roleID: string
    • options: RoleOptions
    • Optional reason: string

    Returns Promise<Role>

editRolePosition

  • editRolePosition(guildID: string, roleID: string, position: number): Promise<void>
  • Parameters

    • guildID: string
    • roleID: string
    • position: number

    Returns Promise<void>

editSelf

  • editSelf(options: { avatar?: string; username?: string }): Promise<ExtendedUser>
  • Parameters

    • options: { avatar?: string; username?: string }
      • Optional avatar?: string
      • Optional username?: string

    Returns Promise<ExtendedUser>

editSelfConnection

  • editSelfConnection(platform: string, id: string, data: { friendSync: boolean; visibility: number }): Promise<Connection>
  • Parameters

    • platform: string
    • id: string
    • data: { friendSync: boolean; visibility: number }
      • friendSync: boolean
      • visibility: number

    Returns Promise<Connection>

editSelfSettings

editStatus

editUserNote

  • editUserNote(userID: string, note: string): Promise<void>
  • Parameters

    • userID: string
    • note: string

    Returns Promise<void>

editWebhook

  • editWebhook(webhookID: string, options: WebhookOptions, token?: string, reason?: string): Promise<Webhook>
  • Parameters

    • webhookID: string
    • options: WebhookOptions
    • Optional token: string
    • Optional reason: string

    Returns Promise<Webhook>

editWebhookMessage

enableSelfMFATOTP

  • enableSelfMFATOTP(secret: string, code: string): Promise<{ backup_codes: { code: string; consumed: boolean }[]; token: string }>
  • Parameters

    • secret: string
    • code: string

    Returns Promise<{ backup_codes: { code: string; consumed: boolean }[]; token: string }>

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

executeSlackWebhook

  • executeSlackWebhook(webhookID: string, token: string, options: Record<string, unknown> & { auth?: boolean }): Promise<void>
  • executeSlackWebhook(webhookID: string, token: string, options: Record<string, unknown> & { auth?: boolean; wait: true }): Promise<Message<GuildTextableChannel>>
  • Parameters

    • webhookID: string
    • token: string
    • options: Record<string, unknown> & { auth?: boolean }

    Returns Promise<void>

  • Parameters

    • webhookID: string
    • token: string
    • options: Record<string, unknown> & { auth?: boolean; wait: true }

    Returns Promise<Message<GuildTextableChannel>>

executeWebhook

extendContext

  • extendContext(options: object): Client
  • Adds things to the context objects the client sends.

    Parameters

    • options: object

    Returns Client

followChannel

  • followChannel(channelID: string, webhookChannelID: string): Promise<ChannelFollow>
  • Parameters

    • channelID: string
    • webhookChannelID: string

    Returns Promise<ChannelFollow>

getBotGateway

  • getBotGateway(): Promise<{ session_start_limit: { max_concurrency: number; remaining: number; reset_after: number; total: number }; shards: number; url: string }>
  • Returns Promise<{ session_start_limit: { max_concurrency: number; remaining: number; reset_after: number; total: number }; shards: number; url: string }>

getChannel

getChannelInvites

getChannelWebhooks

  • getChannelWebhooks(channelID: string): Promise<Webhook[]>

getDMChannel

getDiscoveryCategories

getGateway

  • getGateway(): Promise<{ url: string }>
  • Returns Promise<{ url: string }>

getGuildAuditLog

getGuildAuditLogs

  • getGuildAuditLogs(guildID: string, limit?: number, before?: string, actionType?: number, userID?: string): Promise<GuildAuditLog>
  • deprecated

    Parameters

    • guildID: string
    • Optional limit: number
    • Optional before: string
    • Optional actionType: number
    • Optional userID: string

    Returns Promise<GuildAuditLog>

getGuildBan

  • getGuildBan(guildID: string, userID: string): Promise<{ reason?: string; user: User }>
  • Parameters

    • guildID: string
    • userID: string

    Returns Promise<{ reason?: string; user: User }>

getGuildBans

  • getGuildBans(guildID: string): Promise<{ reason?: string; user: User }[]>
  • Parameters

    • guildID: string

    Returns Promise<{ reason?: string; user: User }[]>

getGuildDiscovery

getGuildEmbed

  • getGuildEmbed(guildID: string): Promise<Widget>
  • deprecated

    Parameters

    • guildID: string

    Returns Promise<Widget>

getGuildIntegrations

getGuildInvites

getGuildPreview

getGuildTemplate

getGuildTemplates

getGuildVanity

  • getGuildVanity(guildID: string): Promise<GuildVanity>

getGuildWebhooks

  • getGuildWebhooks(guildID: string): Promise<Webhook[]>

getGuildWelcomeScreen

getGuildWidget

  • getGuildWidget(guildID: string): Promise<Widget>
  • Parameters

    • guildID: string

    Returns Promise<Widget>

getInvite

  • Parameters

    • inviteID: string
    • Optional withCounts: false

    Returns Promise<Invite<"withoutCount", InviteChannel>>

  • Parameters

    • inviteID: string
    • withCounts: true

    Returns Promise<Invite<"withCount", InviteChannel>>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getMessage

getMessageReaction

  • getMessageReaction(channelID: string, messageID: string, reaction: string, options?: GetMessageReactionOptions): Promise<User[]>
  • getMessageReaction(channelID: string, messageID: string, reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>
  • Parameters

    Returns Promise<User[]>

  • deprecated

    Parameters

    • channelID: string
    • messageID: string
    • reaction: string
    • Optional limit: number
    • Optional before: string
    • Optional after: string

    Returns Promise<User[]>

getMessages

getOAuthApplication

getPins

getPrefixesForMessage

  • getPrefixesForMessage(msg: any): Promise<string[]>

getPruneCount

  • getPruneCount(guildID: string, options?: GetPruneOptions): Promise<number>

getRESTChannel

  • getRESTChannel(channelID: string): Promise<AnyChannel>

getRESTGuild

  • getRESTGuild(guildID: string, withCounts?: boolean): Promise<Guild>
  • Parameters

    • guildID: string
    • Optional withCounts: boolean

    Returns Promise<Guild>

getRESTGuildChannels

getRESTGuildEmoji

  • getRESTGuildEmoji(guildID: string, emojiID: string): Promise<Emoji>
  • Parameters

    • guildID: string
    • emojiID: string

    Returns Promise<Emoji>

getRESTGuildEmojis

  • getRESTGuildEmojis(guildID: string): Promise<Emoji[]>

getRESTGuildMember

  • getRESTGuildMember(guildID: string, memberID: string): Promise<Member>
  • Parameters

    • guildID: string
    • memberID: string

    Returns Promise<Member>

getRESTGuildMembers

getRESTGuildRoles

  • getRESTGuildRoles(guildID: string): Promise<Role[]>
  • Parameters

    • guildID: string

    Returns Promise<Role[]>

getRESTGuilds

  • Parameters

    Returns Promise<Guild[]>

  • deprecated

    Parameters

    • Optional limit: number
    • Optional before: string
    • Optional after: string

    Returns Promise<Guild[]>

getRESTUser

  • getRESTUser(userID: string): Promise<User>
  • Parameters

    • userID: string

    Returns Promise<User>

getSelf

getSelfBilling

  • getSelfBilling(): Promise<{ payment_gateway?: string; payment_source?: { brand: string; expires_month: number; expires_year: number; invalid: boolean; last_4: number; type: string }; premium_subscription?: { canceled_at?: string; created_at: string; current_period_end?: string; current_period_start?: string; ended_at?: string; plan: string; status: number } }>
  • Returns Promise<{ payment_gateway?: string; payment_source?: { brand: string; expires_month: number; expires_year: number; invalid: boolean; last_4: number; type: string }; premium_subscription?: { canceled_at?: string; created_at: string; current_period_end?: string; current_period_start?: string; ended_at?: string; plan: string; status: number } }>

getSelfConnections

getSelfMFACodes

  • getSelfMFACodes(password: string, regenerate?: boolean): Promise<{ backup_codes: { code: string; consumed: boolean }[] }>
  • Parameters

    • password: string
    • Optional regenerate: boolean

    Returns Promise<{ backup_codes: { code: string; consumed: boolean }[] }>

getSelfPayments

  • getSelfPayments(): Promise<{ amount: number; amount_refunded: number; created_at: string; currency: string; description: string; status: number }[]>
  • Returns Promise<{ amount: number; amount_refunded: number; created_at: string; currency: string; description: string; status: number }[]>

getSelfSettings

getUserProfile

getVoiceRegions

  • getVoiceRegions(guildID?: string): Promise<VoiceRegion[]>

getWebhook

  • getWebhook(webhookID: string, token?: string): Promise<Webhook>
  • Parameters

    • webhookID: string
    • Optional token: string

    Returns Promise<Webhook>

getWebhookMessage

hasCommand

  • Returns the command as a list of parsed strings, or null if it's not a valid command

    Parameters

    Returns Promise<null | [string, string, ...string[]]>

joinVoiceChannel

  • joinVoiceChannel(channelID: string, options?: { opusOnly?: boolean; shared?: boolean }): Promise<VoiceConnection>
  • Parameters

    • channelID: string
    • Optional options: { opusOnly?: boolean; shared?: boolean }
      • Optional opusOnly?: boolean
      • Optional shared?: boolean

    Returns Promise<VoiceConnection>

kickGuildMember

  • kickGuildMember(guildID: string, userID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • userID: string
    • Optional reason: string

    Returns Promise<void>

leaveGuild

  • leaveGuild(guildID: string): Promise<void>
  • Parameters

    • guildID: string

    Returns Promise<void>

leaveVoiceChannel

  • leaveVoiceChannel(channelID: string): void
  • Parameters

    • channelID: string

    Returns void

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): Client
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Client
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

pinMessage

  • pinMessage(channelID: string, messageID: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string

    Returns Promise<void>

prefixes

  • Registers a function used to determine what prefixes to use on a per-message basis. Returns a string or an array of strings that should be recognized as prefixes for the message, or undefined to specify that the default prefix should be used. If the allowMention client option is set, mentions will work regardless of the return value of your custom function. The empty prefix also always works in private channels.

    Parameters

    Returns Client

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Client
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Client
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

processCommand

  • processCommand(msg: any): Promise<boolean>
  • Given a message, tries to parse a command from it. If it is a command, executes it and returns true; otherwise, returns false.

    Parameters

    • msg: any

    Returns Promise<boolean>

pruneMembers

purgeChannel

  • purgeChannel(channelID: string, options: PurgeChannelOptions): Promise<number>
  • purgeChannel(channelID: string, limit?: number, filter?: (m: Message<GuildTextableChannel>) => boolean, before?: string, after?: string, reason?: string): Promise<number>

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

reloadCommands

reloadFiles

  • Reloads all commands and events that were loaded via from files. Useful for development to hot-reload components as you work on them.

    Returns Client

removeAllListeners

  • removeAllListeners(event?: string | symbol): Client
  • Parameters

    • Optional event: string | symbol

    Returns Client

removeGroupRecipient

  • removeGroupRecipient(groupID: string, userID: string): Promise<void>
  • Parameters

    • groupID: string
    • userID: string

    Returns Promise<void>

removeGuildMemberRole

  • removeGuildMemberRole(guildID: string, memberID: string, roleID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • memberID: string
    • roleID: string
    • Optional reason: string

    Returns Promise<void>

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Client
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

removeMessageReaction

  • removeMessageReaction(channelID: string, messageID: string, reaction: string, userID?: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string
    • reaction: string
    • Optional userID: string

    Returns Promise<void>

removeMessageReactionEmoji

  • removeMessageReactionEmoji(channelID: string, messageID: string, reaction: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string
    • reaction: string

    Returns Promise<void>

removeMessageReactions

  • removeMessageReactions(channelID: string, messageID: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string

    Returns Promise<void>

removeRelationship

  • removeRelationship(userID: string): Promise<void>
  • Parameters

    • userID: string

    Returns Promise<void>

searchChannelMessages

searchGuildMembers

  • searchGuildMembers(guildID: string, query: string, limit?: number): Promise<Member[]>
  • Parameters

    • guildID: string
    • query: string
    • Optional limit: number

    Returns Promise<Member[]>

searchGuildMessages

sendChannelTyping

  • sendChannelTyping(channelID: string): Promise<void>
  • Parameters

    • channelID: string

    Returns Promise<void>

setDefaultCommand

  • setDefaultCommand(commandName: string): Client
  • Set the default command. This command is executed when allowMention is true and the bot is pinged with no command.

    Parameters

    • commandName: string

    Returns Client

setGlobalRequirements

setMaxListeners

  • setMaxListeners(n: number): Client

splitPrefixFromContent

syncGuildIntegration

  • syncGuildIntegration(guildID: string, integrationID: string): Promise<void>
  • Parameters

    • guildID: string
    • integrationID: string

    Returns Promise<void>

syncGuildTemplate

  • syncGuildTemplate(guildID: string, code: string): Promise<GuildTemplate>

toString

  • toString(): string
  • Returns string

unbanGuildMember

  • unbanGuildMember(guildID: string, userID: string, reason?: string): Promise<void>
  • Parameters

    • guildID: string
    • userID: string
    • Optional reason: string

    Returns Promise<void>

unpinMessage

  • unpinMessage(channelID: string, messageID: string): Promise<void>
  • Parameters

    • channelID: string
    • messageID: string

    Returns Promise<void>

validateDiscoverySearchTerm

  • validateDiscoverySearchTerm(term: string): Promise<{ valid: boolean }>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc