yuuko

ClientEvents

• ClientEvents(event: "commandLoaded", listener: (cmd: Command) => void): T
• ClientEvents(event: "preCommand", listener: (cmd: Command, msg: Message<TextableChannel>, args: string[], ctx: CommandContext) => void): T
• ClientEvents(event: "postCommand", listener: (cmd: Command, msg: Message<TextableChannel>, args: string[], ctx: CommandContext) => void): T
• ClientEvents(event: "invalidCommand", listener: (msg: Message<TextableChannel>, args: string[], ctx: CommandContext) => void): T
• ClientEvents(event: "shardDisconnect" | "error" | "shardPreReady" | "connect", listener: (err: Error, id: number) => void): T
• ClientEvents(event: "shardReady" | "shardResume", listener: (id: number) => void): T
• ClientEvents(event: "ready" | "disconnect", listener: () => void): T
• ClientEvents(event: "callCreate" | "callRing" | "callDelete", listener: (call: Call) => void): T
• ClientEvents(event: "callUpdate", listener: (call: Call, oldCall: OldCall) => void): T
• ClientEvents(event: "channelCreate" | "channelDelete", listener: (channel: AnyChannel) => void): T
• ClientEvents(event: "channelPinUpdate", listener: (channel: TextableChannel, timestamp: number, oldTimestamp: number) => void): T
• ClientEvents(event: "channelRecipientAdd" | "channelRecipientRemove", listener: (channel: GroupChannel, user: User) => void): T
• ClientEvents(event: "channelUpdate", listener: (channel: AnyGuildChannel, oldChannel: OldGuildChannel) => void): T
• ClientEvents(event: "friendSuggestionCreate", listener: (user: User, reasons: FriendSuggestionReasons) => void): T
• ClientEvents(event: "friendSuggestionDelete", listener: (user: User) => void): T
• ClientEvents(event: "guildAvailable" | "guildBanAdd" | "guildBanRemove", listener: (guild: Guild, user: User) => void): T
• ClientEvents(event: "guildDelete" | "guildUnavailable" | "guildCreate", listener: (guild: Guild) => void): T
• ClientEvents(event: "guildEmojisUpdate", listener: (guild: Guild, emojis: Emoji[], oldEmojis: Emoji[]) => void): T
• ClientEvents(event: "guildMemberAdd", listener: (guild: Guild, member: Member) => void): T
• ClientEvents(event: "guildMemberChunk", listener: (guild: Guild, members: Member[]) => void): T
• ClientEvents(event: "guildMemberRemove", listener: (guild: Guild, member: MemberPartial | Member) => void): T
• ClientEvents(event: "guildMemberUpdate", listener: (guild: Guild, member: Member, oldMember: { nick?: undefined | string; roles: string[] }) => void): T
• ClientEvents(event: "guildRoleCreate" | "guildRoleDelete", listener: (guild: Guild, role: Role) => void): T
• ClientEvents(event: "guildRoleUpdate", listener: (guild: Guild, role: Role, oldRole: OldRole) => void): T
• ClientEvents(event: "guildUpdate", listener: (guild: Guild, oldGuild: OldGuild) => void): T
• ClientEvents(event: "hello", listener: (trace: string[], id: number) => void): T
• ClientEvents(event: "inviteCreate" | "inviteDelete", listener: (guild: Guild, invite: GuildInvite) => void): T
• ClientEvents(event: "messageCreate", listener: (message: Message<TextableChannel>) => void): T
• ClientEvents(event: "messageDelete" | "messageReactionRemoveAll", listener: (message: PossiblyUncachedMessage) => void): T
• ClientEvents(event: "messageReactionRemoveEmoji", listener: (message: PossiblyUncachedMessage, emoji: PartialEmoji) => void): T
• ClientEvents(event: "messageDeleteBulk", listener: (messages: PossiblyUncachedMessage[]) => void): T
• ClientEvents(event: "messageReactionAdd" | "messageReactionRemove", listener: (message: PossiblyUncachedMessage, emoji: Emoji, userID: string) => void): T
• ClientEvents(event: "messageUpdate", listener: (message: Message<TextableChannel>, oldMessage?: OldMessage) => void): T
• ClientEvents(event: "presenceUpdate", listener: (other: Member | Relationship, oldPresence?: Presence) => void): T
• ClientEvents(event: "rawREST", listener: (request: RawRESTRequest) => void): T
• ClientEvents(event: "rawWS" | "unknown", listener: (packet: RawPacket, id: number) => void): T
• ClientEvents(event: "relationshipAdd" | "relationshipRemove", listener: (relationship: Relationship) => void): T
• ClientEvents(event: "relationshipUpdate", listener: (relationship: Relationship, oldRelationship: { type: number }) => void): T
• ClientEvents(event: "typingStart", listener: (channel: TextableChannel, user: User) => void): T
• ClientEvents(event: "unavailableGuildCreate", listener: (guild: UnavailableGuild) => void): T
• ClientEvents(event: "userUpdate", listener: (user: User, oldUser: { avatar?: undefined | string; discriminator: string; username: string }) => void): T
• ClientEvents(event: "voiceChannelJoin", listener: (member: Member, newChannel: VoiceChannel) => void): T
• ClientEvents(event: "voiceChannelLeave", listener: (member: Member, oldChannel: VoiceChannel) => void): T
• ClientEvents(event: "voiceChannelSwitch", listener: (member: Member, newChannel: VoiceChannel, oldChannel: VoiceChannel) => void): T
• ClientEvents(event: "voiceStateUpdate", listener: (member: Member, oldState: OldVoiceState) => void): T
• ClientEvents(event: "warn" | "debug", listener: (message: string, id: number) => void): T
• ClientEvents(event: string, listener: Function): T

• Parameters

  • event: "commandLoaded"

  • listener: (cmd: Command) => void

    • • (cmd: Command): void

      • Parameters

        • cmd: Command

        Returns void

  Returns T

• Parameters

  • event: "preCommand"

  • listener: (cmd: Command, msg: Message<TextableChannel>, args: string[], ctx: CommandContext) => void

    • • (cmd: Command, msg: Message<TextableChannel>, args: string[], ctx: CommandContext): void

      • Parameters

        • cmd: Command

        • msg: Message<TextableChannel>

        • args: string[]

        • ctx: CommandContext

        Returns void

  Returns T

• Parameters

  • event: "postCommand"

  • listener: (cmd: Command, msg: Message<TextableChannel>, args: string[], ctx: CommandContext) => void

    • • (cmd: Command, msg: Message<TextableChannel>, args: string[], ctx: CommandContext): void

      • Parameters

        • cmd: Command

        • msg: Message<TextableChannel>

        • args: string[]

        • ctx: CommandContext

        Returns void

  Returns T

• Parameters

  • event: "invalidCommand"

  • listener: (msg: Message<TextableChannel>, args: string[], ctx: CommandContext) => void

    • • (msg: Message<TextableChannel>, args: string[], ctx: CommandContext): void

      • Parameters

        • msg: Message<TextableChannel>

        • args: string[]

        • ctx: CommandContext

        Returns void

  Returns T

• Parameters

  • event: "shardDisconnect" | "error" | "shardPreReady" | "connect"

  • listener: (err: Error, id: number) => void

    • • (err: Error, id: number): void

      • Parameters

        • err: Error

        • id: number

        Returns void

  Returns T

• Parameters

  • event: "shardReady" | "shardResume"

  • listener: (id: number) => void

    • • (id: number): void

      • Parameters

        • id: number

        Returns void

  Returns T

• Parameters

  • event: "ready" | "disconnect"

  • listener: () => void

    • • (): void

      • Returns void

  Returns T

• Parameters

  • event: "callCreate" | "callRing" | "callDelete"

  • listener: (call: Call) => void

    • • (call: Call): void

      • Parameters

        • call: Call

        Returns void

  Returns T

• Parameters

  • event: "callUpdate"

  • listener: (call: Call, oldCall: OldCall) => void

    • • (call: Call, oldCall: OldCall): void

      • Parameters

        • call: Call

        • oldCall: OldCall

        Returns void

  Returns T

• Parameters

  • event: "channelCreate" | "channelDelete"

  • listener: (channel: AnyChannel) => void

    • • (channel: AnyChannel): void

      • Parameters

        • channel: AnyChannel

        Returns void

  Returns T

• Parameters

  • event: "channelPinUpdate"

  • listener: (channel: TextableChannel, timestamp: number, oldTimestamp: number) => void

    • • (channel: TextableChannel, timestamp: number, oldTimestamp: number): void

      • Parameters

        • channel: TextableChannel

        • timestamp: number

        • oldTimestamp: number

        Returns void

  Returns T

• Parameters

  • event: "channelRecipientAdd" | "channelRecipientRemove"

  • listener: (channel: GroupChannel, user: User) => void

    • • (channel: GroupChannel, user: User): void

      • Parameters

        • channel: GroupChannel

        • user: User

        Returns void

  Returns T

• Parameters

  • event: "channelUpdate"

  • listener: (channel: AnyGuildChannel, oldChannel: OldGuildChannel) => void

    • • (channel: AnyGuildChannel, oldChannel: OldGuildChannel): void

      • Parameters

        • channel: AnyGuildChannel

        • oldChannel: OldGuildChannel

        Returns void

  Returns T

• Parameters

  • event: "friendSuggestionCreate"

  • listener: (user: User, reasons: FriendSuggestionReasons) => void

    • • (user: User, reasons: FriendSuggestionReasons): void

      • Parameters

        • user: User

        • reasons: FriendSuggestionReasons

        Returns void

  Returns T

• Parameters

  • event: "friendSuggestionDelete"

  • listener: (user: User) => void

    • • (user: User): void

      • Parameters

        • user: User

        Returns void

  Returns T

• Parameters

  • event: "guildAvailable" | "guildBanAdd" | "guildBanRemove"

  • listener: (guild: Guild, user: User) => void

    • • (guild: Guild, user: User): void

      • Parameters

        • guild: Guild

        • user: User

        Returns void

  Returns T

• Parameters

  • event: "guildDelete" | "guildUnavailable" | "guildCreate"

  • listener: (guild: Guild) => void

    • • (guild: Guild): void

      • Parameters

        • guild: Guild

        Returns void

  Returns T

• Parameters

  • event: "guildEmojisUpdate"

  • listener: (guild: Guild, emojis: Emoji[], oldEmojis: Emoji[]) => void

    • • (guild: Guild, emojis: Emoji[], oldEmojis: Emoji[]): void

      • Parameters

        • guild: Guild

        • emojis: Emoji[]

        • oldEmojis: Emoji[]

        Returns void

  Returns T

• Parameters

  • event: "guildMemberAdd"

  • listener: (guild: Guild, member: Member) => void

    • • (guild: Guild, member: Member): void

      • Parameters

        • guild: Guild

        • member: Member

        Returns void

  Returns T

• Parameters

  • event: "guildMemberChunk"

  • listener: (guild: Guild, members: Member[]) => void

    • • (guild: Guild, members: Member[]): void

      • Parameters

        • guild: Guild

        • members: Member[]

        Returns void

  Returns T

• Parameters

  • event: "guildMemberRemove"

  • listener: (guild: Guild, member: MemberPartial | Member) => void

    • • (guild: Guild, member: MemberPartial | Member): void

      • Parameters

        • guild: Guild

        • member: MemberPartial | Member

        Returns void

  Returns T

• Parameters

  • event: "guildMemberUpdate"

  • listener: (guild: Guild, member: Member, oldMember: { nick?: undefined | string; roles: string[] }) => void

    • • (guild: Guild, member: Member, oldMember: { nick?: undefined | string; roles: string[] }): void

      • Parameters

        • guild: Guild

        • member: Member

        • oldMember: { nick?: undefined | string; roles: string[] }

          • Optional nick?: undefined | string

          • roles: string[]

        Returns void

  Returns T

• Parameters

  • event: "guildRoleCreate" | "guildRoleDelete"

  • listener: (guild: Guild, role: Role) => void

    • • (guild: Guild, role: Role): void

      • Parameters

        • guild: Guild

        • role: Role

        Returns void

  Returns T

• Parameters

  • event: "guildRoleUpdate"

  • listener: (guild: Guild, role: Role, oldRole: OldRole) => void

    • • (guild: Guild, role: Role, oldRole: OldRole): void

      • Parameters

        • guild: Guild

        • role: Role

        • oldRole: OldRole

        Returns void

  Returns T

• Parameters

  • event: "guildUpdate"

  • listener: (guild: Guild, oldGuild: OldGuild) => void

    • • (guild: Guild, oldGuild: OldGuild): void

      • Parameters

        • guild: Guild

        • oldGuild: OldGuild

        Returns void

  Returns T

• Parameters

  • event: "hello"

  • listener: (trace: string[], id: number) => void

    • • (trace: string[], id: number): void

      • Parameters

        • trace: string[]

        • id: number

        Returns void

  Returns T

• Parameters

  • event: "inviteCreate" | "inviteDelete"

  • listener: (guild: Guild, invite: GuildInvite) => void

    • • (guild: Guild, invite: GuildInvite): void

      • Parameters

        • guild: Guild

        • invite: GuildInvite

        Returns void

  Returns T

• Parameters

  • event: "messageCreate"

  • listener: (message: Message<TextableChannel>) => void

    • • (message: Message<TextableChannel>): void

      • Parameters

        • message: Message<TextableChannel>

        Returns void

  Returns T

• Parameters

  • event: "messageDelete" | "messageReactionRemoveAll"

  • listener: (message: PossiblyUncachedMessage) => void

    • • (message: PossiblyUncachedMessage): void

      • Parameters

        • message: PossiblyUncachedMessage

        Returns void

  Returns T

• Parameters

  • event: "messageReactionRemoveEmoji"

  • listener: (message: PossiblyUncachedMessage, emoji: PartialEmoji) => void

    • • (message: PossiblyUncachedMessage, emoji: PartialEmoji): void

      • Parameters

        • message: PossiblyUncachedMessage

        • emoji: PartialEmoji

        Returns void

  Returns T

• Parameters

  • event: "messageDeleteBulk"

  • listener: (messages: PossiblyUncachedMessage[]) => void

    • • (messages: PossiblyUncachedMessage[]): void

      • Parameters

        • messages: PossiblyUncachedMessage[]

        Returns void

  Returns T

• Parameters

  • event: "messageReactionAdd" | "messageReactionRemove"

  • listener: (message: PossiblyUncachedMessage, emoji: Emoji, userID: string) => void

    • • (message: PossiblyUncachedMessage, emoji: Emoji, userID: string): void

      • Parameters

        • message: PossiblyUncachedMessage

        • emoji: Emoji

        • userID: string

        Returns void

  Returns T

• Parameters

  • event: "messageUpdate"

  • listener: (message: Message<TextableChannel>, oldMessage?: OldMessage) => void

    • • (message: Message<TextableChannel>, oldMessage?: OldMessage): void

      • Parameters

        • message: Message<TextableChannel>

        • Optional oldMessage: OldMessage

        Returns void

  Returns T

• Parameters

  • event: "presenceUpdate"

  • listener: (other: Member | Relationship, oldPresence?: Presence) => void

    • • (other: Member | Relationship, oldPresence?: Presence): void

      • Parameters

        • other: Member | Relationship

        • Optional oldPresence: Presence

        Returns void

  Returns T

• Parameters

  • event: "rawREST"

  • listener: (request: RawRESTRequest) => void

    • • (request: RawRESTRequest): void

      • Parameters

        • request: RawRESTRequest

        Returns void

  Returns T

• Parameters

  • event: "rawWS" | "unknown"

  • listener: (packet: RawPacket, id: number) => void

    • • (packet: RawPacket, id: number): void

      • Parameters

        • packet: RawPacket

        • id: number

        Returns void

  Returns T

• Parameters

  • event: "relationshipAdd" | "relationshipRemove"

  • listener: (relationship: Relationship) => void

    • • (relationship: Relationship): void

      • Parameters

        • relationship: Relationship

        Returns void

  Returns T

• Parameters

  • event: "relationshipUpdate"

  • listener: (relationship: Relationship, oldRelationship: { type: number }) => void

    • • (relationship: Relationship, oldRelationship: { type: number }): void

      • Parameters

        • relationship: Relationship

        • oldRelationship: { type: number }

          • type: number

        Returns void

  Returns T

• Parameters

  • event: "typingStart"

  • listener: (channel: TextableChannel, user: User) => void

    • • (channel: TextableChannel, user: User): void

      • Parameters

        • channel: TextableChannel

        • user: User

        Returns void

  Returns T

• Parameters

  • event: "unavailableGuildCreate"

  • listener: (guild: UnavailableGuild) => void

    • • (guild: UnavailableGuild): void

      • Parameters

        • guild: UnavailableGuild

        Returns void

  Returns T

• Parameters

  • event: "userUpdate"

  • listener: (user: User, oldUser: { avatar?: undefined | string; discriminator: string; username: string }) => void

    • • (user: User, oldUser: { avatar?: undefined | string; discriminator: string; username: string }): void

      • Parameters

        • user: User

        • oldUser: { avatar?: undefined | string; discriminator: string; username: string }

          • Optional avatar?: undefined | string

          • discriminator: string

          • username: string

        Returns void

  Returns T

• Parameters

  • event: "voiceChannelJoin"

  • listener: (member: Member, newChannel: VoiceChannel) => void

    • • (member: Member, newChannel: VoiceChannel): void

      • Parameters

        • member: Member

        • newChannel: VoiceChannel

        Returns void

  Returns T

• Parameters

  • event: "voiceChannelLeave"

  • listener: (member: Member, oldChannel: VoiceChannel) => void

    • • (member: Member, oldChannel: VoiceChannel): void

      • Parameters

        • member: Member

        • oldChannel: VoiceChannel

        Returns void

  Returns T

• Parameters

  • event: "voiceChannelSwitch"

  • listener: (member: Member, newChannel: VoiceChannel, oldChannel: VoiceChannel) => void

    • • (member: Member, newChannel: VoiceChannel, oldChannel: VoiceChannel): void

      • Parameters

        • member: Member

        • newChannel: VoiceChannel

        • oldChannel: VoiceChannel

        Returns void

  Returns T

• Parameters

  • event: "voiceStateUpdate"

  • listener: (member: Member, oldState: OldVoiceState) => void

    • • (member: Member, oldState: OldVoiceState): void

      • Parameters

        • member: Member

        • oldState: OldVoiceState

        Returns void

  Returns T

• Parameters

  • event: "warn" | "debug"

  • listener: (message: string, id: number) => void

    • • (message: string, id: number): void

      • Parameters

        • message: string

        • id: number

        Returns void

  Returns T

• Parameters

  • event: string

  • listener: Function

  Returns T