Client | yuuko

Hierarchy

EventEmitter
- Client
  - CommandClient
  - Client

Index

Constructors

constructor

Methods

Constructors

constructor

new Client(token: string, options?: ClientOptions): Client

- Defined in node_modules/eris/index.d.ts:1360
Parameters
- token: string
- Optional options: ClientOptions
Returns Client

Properties

Optional application

application: undefined | { flags: number; id: string }

bot

bot: boolean

channelGuildMap

channelGuildMap: {}

Type declaration

[s: string]: string

Optional gatewayURL

gatewayURL: undefined | string

groupChannels

groupChannels: Collection<GroupChannel>

guildShardMap

guildShardMap: {}

Type declaration

[s: string]: number

guilds

guilds: Collection<Guild>

lastConnect

lastConnect: number

lastReconnectDelay

lastReconnectDelay: number

notes

notes: {}

Type declaration

[s: string]: string

on

on: ClientEvents<Client>

options

options: ClientOptions

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

unavailableGuilds

unavailableGuilds: Collection<UnavailableGuild>

uptime

uptime: number

user

user: ExtendedUser

userGuildSettings

userGuildSettings: {}

Type declaration

[s: string]: GuildSettings

userSettings

userSettings: UserSettings

users

users: Collection<User>

voiceConnections

voiceConnections: VoiceConnectionManager<VoiceConnection>

Static defaultMaxListeners

defaultMaxListeners: number

Methods

acceptInvite

acceptInvite(inviteID: string): Promise<Invite<"withoutCount", InviteChannel>>

- Defined in node_modules/eris/index.d.ts:1362
Parameters
- inviteID: string
Returns Promise<Invite<"withoutCount", InviteChannel>>

addGroupRecipient

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

- Defined in node_modules/eris/index.d.ts:1363
Parameters
- groupID: string
- userID: string
Returns Promise<void>

addGuildDiscoverySubcategory

addGuildDiscoverySubcategory(guildID: string, categoryID: string, reason?: string): Promise<DiscoverySubcategoryResponse>

- Defined in node_modules/eris/index.d.ts:1364
Parameters
- guildID: string
- categoryID: string
- Optional reason: string
Returns Promise<DiscoverySubcategoryResponse>

addGuildMemberRole

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

- Defined in node_modules/eris/index.d.ts:1365
Parameters
- guildID: string
- memberID: string
- roleID: string
- Optional reason: string
Returns Promise<void>

addListener

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

- Defined in node_modules/@types/node/globals.d.ts:547
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>

- Defined in node_modules/eris/index.d.ts:1366
Parameters
- channelID: string
- messageID: string
- reaction: string
Returns Promise<void>
- Defined in node_modules/eris/index.d.ts:1368
deprecated

Parameters
- channelID: string
- messageID: string
- reaction: string
- userID: string
Returns Promise<void>

addRelationship

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

- Defined in node_modules/eris/index.d.ts:1369
Parameters
- userID: string
- Optional block: boolean
Returns Promise<void>

addSelfPremiumSubscription

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

- Defined in node_modules/eris/index.d.ts:1370
Parameters
- token: string
- plan: string
Returns Promise<void>

banGuildMember

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

- Defined in node_modules/eris/index.d.ts:1371
Parameters
- guildID: string
- userID: string
- Optional deleteMessageDays: number
- Optional reason: string
Returns Promise<void>

closeVoiceConnection

closeVoiceConnection(guildID: string): void

- Defined in node_modules/eris/index.d.ts:1372
Parameters
- guildID: string
Returns void

connect

connect(): Promise<void>

- Defined in node_modules/eris/index.d.ts:1373
Returns Promise<void>

createChannel

createChannel(guildID: string, name: string): Promise<TextChannel>
createChannel(guildID: string, name: string, type: 0, options?: CreateChannelOptions): Promise<TextChannel>
createChannel(guildID: string, name: string, type: 2, options?: CreateChannelOptions): Promise<VoiceChannel>
createChannel(guildID: string, name: string, type: 4, options?: CreateChannelOptions): Promise<CategoryChannel>
createChannel(guildID: string, name: string, type: 5, options?: CreateChannelOptions): Promise<NewsChannel>
createChannel(guildID: string, name: string, type: 6, options?: CreateChannelOptions): Promise<StoreChannel>
createChannel(guildID: string, name: string, type?: number, options?: CreateChannelOptions): Promise<unknown>
createChannel(guildID: string, name: string, type: 0, reason?: string, options?: string | CreateChannelOptions): Promise<TextChannel>
createChannel(guildID: string, name: string, type: 2, reason?: string, options?: string | CreateChannelOptions): Promise<VoiceChannel>
createChannel(guildID: string, name: string, type: 4, reason?: string, options?: string | CreateChannelOptions): Promise<CategoryChannel>
createChannel(guildID: string, name: string, type: 5, reason?: string, options?: string | CreateChannelOptions): Promise<NewsChannel>
createChannel(guildID: string, name: string, type: 6, reason?: string, options?: string | CreateChannelOptions): Promise<StoreChannel>
createChannel(guildID: string, name: string, type?: number, reason?: string, options?: string | CreateChannelOptions): Promise<unknown>

- Defined in node_modules/eris/index.d.ts:1374
Parameters
- guildID: string
- name: string
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1375
Parameters
- guildID: string
- name: string
- type: 0
- Optional options: CreateChannelOptions
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1381
Parameters
- guildID: string
- name: string
- type: 2
- Optional options: CreateChannelOptions
Returns Promise<VoiceChannel>
- Defined in node_modules/eris/index.d.ts:1387
Parameters
- guildID: string
- name: string
- type: 4
- Optional options: CreateChannelOptions
Returns Promise<CategoryChannel>
- Defined in node_modules/eris/index.d.ts:1393
Parameters
- guildID: string
- name: string
- type: 5
- Optional options: CreateChannelOptions
Returns Promise<NewsChannel>
- Defined in node_modules/eris/index.d.ts:1399
Parameters
- guildID: string
- name: string
- type: 6
- Optional options: CreateChannelOptions
Returns Promise<StoreChannel>
- Defined in node_modules/eris/index.d.ts:1405
Parameters
- guildID: string
- name: string
- Optional type: number
- Optional options: CreateChannelOptions
Returns Promise<unknown>
- Defined in node_modules/eris/index.d.ts:1412
deprecated

Parameters
- guildID: string
- name: string
- type: 0
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1420
deprecated

Parameters
- guildID: string
- name: string
- type: 2
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<VoiceChannel>
- Defined in node_modules/eris/index.d.ts:1428
deprecated

Parameters
- guildID: string
- name: string
- type: 4
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<CategoryChannel>
- Defined in node_modules/eris/index.d.ts:1436
deprecated

Parameters
- guildID: string
- name: string
- type: 5
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<NewsChannel>
- Defined in node_modules/eris/index.d.ts:1444
deprecated

Parameters
- guildID: string
- name: string
- type: 6
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<StoreChannel>
- Defined in node_modules/eris/index.d.ts:1452
deprecated

Parameters
- guildID: string
- name: string
- Optional type: number
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<unknown>

createChannelInvite

createChannelInvite(channelID: string, options?: CreateChannelInviteOptions, reason?: string): Promise<Invite<"withoutCount", InviteChannel>>

- Defined in node_modules/eris/index.d.ts:1459
Parameters
- channelID: string
- Optional options: CreateChannelInviteOptions
- Optional reason: string
Returns Promise<Invite<"withoutCount", InviteChannel>>

createChannelWebhook

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

- Defined in node_modules/eris/index.d.ts:1464
Parameters
- channelID: string
- options: { avatar?: undefined | null | string; name: string }
  - Optional avatar?: undefined | null | string
  - name: string
- Optional reason: string
Returns Promise<Webhook>

createGroupChannel

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

- Defined in node_modules/eris/index.d.ts:1469
Parameters
- userIDs: string[]
Returns Promise<GroupChannel>

createGuild

createGuild(name: string, options?: CreateGuildOptions): Promise<Guild>

- Defined in node_modules/eris/index.d.ts:1470
Parameters
- name: string
- Optional options: CreateGuildOptions
Returns Promise<Guild>

createGuildEmoji

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

- Defined in node_modules/eris/index.d.ts:1471
Parameters
- guildID: string
- options: EmojiOptions
- Optional reason: string
Returns Promise<Emoji>

createGuildFromTemplate

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

- Defined in node_modules/eris/index.d.ts:1472
Parameters
- code: string
- name: string
- Optional icon: string
Returns Promise<Guild>

createGuildTemplate

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

- Defined in node_modules/eris/index.d.ts:1473
Parameters
- guildID: string
- name: string
- Optional description: null | string
Returns Promise<GuildTemplate>

createMessage

createMessage(channelID: string, content: MessageContent, file?: MessageFile | MessageFile[]): Promise<Message<TextableChannel>>

- Defined in node_modules/eris/index.d.ts:1474
Parameters
- channelID: string
- content: MessageContent
- Optional file: MessageFile | MessageFile[]
Returns Promise<Message<TextableChannel>>

createRole

createRole(guildID: string, options?: Role | RoleOptions, reason?: string): Promise<Role>

- Defined in node_modules/eris/index.d.ts:1475
Parameters
- guildID: string
- Optional options: Role | RoleOptions
- Optional reason: string
Returns Promise<Role>

crosspostMessage

crosspostMessage(channelID: string, messageID: string): Promise<Message<TextableChannel>>

- Defined in node_modules/eris/index.d.ts:1476
Parameters
- channelID: string
- messageID: string
Returns Promise<Message<TextableChannel>>

deleteChannel

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

- Defined in node_modules/eris/index.d.ts:1477
Parameters
- channelID: string
- Optional reason: string
Returns Promise<void>

deleteChannelPermission

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

- Defined in node_modules/eris/index.d.ts:1478
Parameters
- channelID: string
- overwriteID: string
- Optional reason: string
Returns Promise<void>

deleteGuild

deleteGuild(guildID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1479
Parameters
- guildID: string
Returns Promise<void>

deleteGuildDiscoverySubcategory

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

- Defined in node_modules/eris/index.d.ts:1480
Parameters
- guildID: string
- categoryID: string
- Optional reason: string
Returns Promise<void>

deleteGuildEmoji

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

- Defined in node_modules/eris/index.d.ts:1481
Parameters
- guildID: string
- emojiID: string
- Optional reason: string
Returns Promise<void>

deleteGuildIntegration

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

- Defined in node_modules/eris/index.d.ts:1482
Parameters
- guildID: string
- integrationID: string
Returns Promise<void>

deleteGuildTemplate

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

- Defined in node_modules/eris/index.d.ts:1483
Parameters
- guildID: string
- code: string
Returns Promise<GuildTemplate>

deleteInvite

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

- Defined in node_modules/eris/index.d.ts:1484
Parameters
- inviteID: string
- Optional reason: string
Returns Promise<void>

deleteMessage

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

- Defined in node_modules/eris/index.d.ts:1485
Parameters
- channelID: string
- messageID: string
- Optional reason: string
Returns Promise<void>

deleteMessages

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

- Defined in node_modules/eris/index.d.ts:1486
Parameters
- channelID: string
- messageIDs: string[]
- Optional reason: string
Returns Promise<void>

deleteRole

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

- Defined in node_modules/eris/index.d.ts:1487
Parameters
- guildID: string
- roleID: string
- Optional reason: string
Returns Promise<void>

deleteSelfConnection

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

- Defined in node_modules/eris/index.d.ts:1488
Parameters
- platform: string
- id: string
Returns Promise<void>

deleteSelfPremiumSubscription

deleteSelfPremiumSubscription(): Promise<void>

- Defined in node_modules/eris/index.d.ts:1489
Returns Promise<void>

deleteUserNote

deleteUserNote(userID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1490
Parameters
- userID: string
Returns Promise<void>

deleteWebhook

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

- Defined in node_modules/eris/index.d.ts:1491
Parameters
- webhookID: string
- Optional token: string
- Optional reason: string
Returns Promise<void>

deleteWebhookMessage

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

- Defined in node_modules/eris/index.d.ts:1492
Parameters
- webhookID: string
- token: string
- messageID: string
Returns Promise<void>

disableSelfMFATOTP

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

- Defined in node_modules/eris/index.d.ts:1493
Parameters
- code: string
Returns Promise<{ token: string }>

disconnect

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

- Defined in node_modules/eris/index.d.ts:1494
Parameters
- options: { reconnect?: undefined | boolean | "auto" }
  - Optional reconnect?: undefined | boolean | "auto"
Returns void

editAFK

editAFK(afk: boolean): void

- Defined in node_modules/eris/index.d.ts:1495
Parameters
- afk: boolean
Returns void

editChannel

editChannel(channelID: string, options: EditChannelOptions, reason?: string): Promise<TextChannel | NewsChannel | VoiceChannel | StageChannel | CategoryChannel | StoreChannel | GroupChannel>

- Defined in node_modules/eris/index.d.ts:1496
Parameters
- channelID: string
- options: EditChannelOptions
- Optional reason: string
Returns Promise<TextChannel | NewsChannel | VoiceChannel | StageChannel | CategoryChannel | StoreChannel | GroupChannel>

editChannelPermission

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

- Defined in node_modules/eris/index.d.ts:1501
Parameters
- channelID: string
- overwriteID: string
- allow: number | bigint
- deny: number | bigint
- type: string
- Optional reason: string
Returns Promise<void>

editChannelPosition

editChannelPosition(channelID: string, position: number, options?: EditChannelPositionOptions): Promise<void>

- Defined in node_modules/eris/index.d.ts:1509
Parameters
- channelID: string
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

editGuild

editGuild(guildID: string, options: GuildOptions, reason?: string): Promise<Guild>

- Defined in node_modules/eris/index.d.ts:1510
Parameters
- guildID: string
- options: GuildOptions
- Optional reason: string
Returns Promise<Guild>

editGuildDiscovery

editGuildDiscovery(guildID: string, options?: DiscoveryOptions): Promise<DiscoveryMetadata>

- Defined in node_modules/eris/index.d.ts:1511
Parameters
- guildID: string
- Optional options: DiscoveryOptions
Returns Promise<DiscoveryMetadata>

editGuildEmoji

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

- Defined in node_modules/eris/index.d.ts:1512
Parameters
- guildID: string
- emojiID: string
- options: { name?: undefined | string; roles?: undefined | string[] }
  - Optional name?: undefined | string
  - Optional roles?: undefined | string[]
- Optional reason: string
Returns Promise<Emoji>

editGuildIntegration

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

- Defined in node_modules/eris/index.d.ts:1518
Parameters
- guildID: string
- integrationID: string
- options: IntegrationOptions
Returns Promise<void>

editGuildMember

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

- Defined in node_modules/eris/index.d.ts:1519
Parameters
- guildID: string
- memberID: string
- options: MemberOptions
- Optional reason: string
Returns Promise<void>

editGuildTemplate

editGuildTemplate(guildID: string, code: string, options: GuildTemplateOptions): Promise<GuildTemplate>

- Defined in node_modules/eris/index.d.ts:1520
Parameters
- guildID: string
- code: string
- options: GuildTemplateOptions
Returns Promise<GuildTemplate>

editGuildWidget

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

- Defined in node_modules/eris/index.d.ts:1521
Parameters
- guildID: string
- options: Widget
Returns Promise<Widget>

editMessage

editMessage(channelID: string, messageID: string, content: MessageContent): Promise<Message<TextableChannel>>

- Defined in node_modules/eris/index.d.ts:1522
Parameters
- channelID: string
- messageID: string
- content: MessageContent
Returns Promise<Message<TextableChannel>>

editNickname

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

- Defined in node_modules/eris/index.d.ts:1523
Parameters
- guildID: string
- nick: string
- Optional reason: string
Returns Promise<void>

editRole

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

- Defined in node_modules/eris/index.d.ts:1524
Parameters
- guildID: string
- roleID: string
- options: RoleOptions
- Optional reason: string
Returns Promise<Role>

editRolePosition

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

- Defined in node_modules/eris/index.d.ts:1525
Parameters
- guildID: string
- roleID: string
- position: number
Returns Promise<void>

editSelf

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

- Defined in node_modules/eris/index.d.ts:1526
Parameters
- options: { avatar?: undefined | string; username?: undefined | string }
  - Optional avatar?: undefined | string
  - Optional username?: undefined | string
Returns Promise<ExtendedUser>

editSelfConnection

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

- Defined in node_modules/eris/index.d.ts:1527
Parameters
- platform: string
- id: string
- data: { friendSync: boolean; visibility: number }
  - friendSync: boolean
  - visibility: number
Returns Promise<Connection>

editSelfSettings

editSelfSettings(data: UserSettings): Promise<UserSettings>

- Defined in node_modules/eris/index.d.ts:1532
Parameters
- data: UserSettings
Returns Promise<UserSettings>

editStatus

editStatus(status?: "online" | "idle" | "dnd" | "offline", game?: ActivityPartial<BotActivityType>): void

- Defined in node_modules/eris/index.d.ts:1533
Parameters
- Optional status: "online" | "idle" | "dnd" | "offline"
- Optional game: ActivityPartial<BotActivityType>
Returns void

editUserNote

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

- Defined in node_modules/eris/index.d.ts:1534
Parameters
- userID: string
- note: string
Returns Promise<void>

editWebhook

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

- Defined in node_modules/eris/index.d.ts:1535
Parameters
- webhookID: string
- options: WebhookOptions
- Optional token: string
- Optional reason: string
Returns Promise<Webhook>

editWebhookMessage

editWebhookMessage(webhookID: string, token: string, messageID: string, options: Pick<WebhookPayload, "content" | "embeds" | "file" | "allowedMentions">): Promise<Message<GuildTextableChannel>>

- Defined in node_modules/eris/index.d.ts:1541
Parameters
- webhookID: string
- token: string
- messageID: string
- options: Pick<WebhookPayload, "content" | "embeds" | "file" | "allowedMentions">
Returns Promise<Message<GuildTextableChannel>>

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

enableSelfMFATOTP

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

- Defined in node_modules/eris/index.d.ts:1547
Parameters
- secret: string
- code: string
Returns Promise<{ backup_codes: { code: string; consumed: boolean }[]; token: string }>

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/globals.d.ts:562
Returns (string | symbol)[]

executeSlackWebhook

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

- Defined in node_modules/eris/index.d.ts:1551
Parameters
- webhookID: string
- token: string
- options: Record<string, unknown> & { auth?: undefined | boolean }
Returns Promise<void>
- Defined in node_modules/eris/index.d.ts:1552
Parameters
- webhookID: string
- token: string
- options: Record<string, unknown> & { auth?: undefined | boolean; wait: true }
Returns Promise<Message<GuildTextableChannel>>

executeWebhook

executeWebhook(webhookID: string, token: string, options: WebhookPayload & { wait: true }): Promise<Message<GuildTextableChannel>>
executeWebhook(webhookID: string, token: string, options: WebhookPayload): Promise<void>

- Defined in node_modules/eris/index.d.ts:1553
Parameters
- webhookID: string
- token: string
- options: WebhookPayload & { wait: true }
Returns Promise<Message<GuildTextableChannel>>
- Defined in node_modules/eris/index.d.ts:1554
Parameters
- webhookID: string
- token: string
- options: WebhookPayload
Returns Promise<void>

followChannel

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

- Defined in node_modules/eris/index.d.ts:1555
Parameters
- channelID: string
- webhookChannelID: string
Returns Promise<ChannelFollow>

getBotGateway

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

- Defined in node_modules/eris/index.d.ts:1556
Returns Promise<{ session_start_limit: { remaining: number; reset_after: number; total: number }; shards: number; url: string }>

getChannel

getChannel(channelID: string): AnyChannel

- Defined in node_modules/eris/index.d.ts:1557
Parameters
- channelID: string
Returns AnyChannel

getChannelInvites

getChannelInvites(channelID: string): Promise<Invite<"withMetadata", InviteChannel>[]>

- Defined in node_modules/eris/index.d.ts:1558
Parameters
- channelID: string
Returns Promise<Invite<"withMetadata", InviteChannel>[]>

getChannelWebhooks

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

- Defined in node_modules/eris/index.d.ts:1559
Parameters
- channelID: string
Returns Promise<Webhook[]>

getDMChannel

getDMChannel(userID: string): Promise<PrivateChannel>

- Defined in node_modules/eris/index.d.ts:1561
Parameters
- userID: string
Returns Promise<PrivateChannel>

getDiscoveryCategories

getDiscoveryCategories(): Promise<DiscoveryCategory[]>

- Defined in node_modules/eris/index.d.ts:1560
Returns Promise<DiscoveryCategory[]>

getGateway

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

- Defined in node_modules/eris/index.d.ts:1562
Returns Promise<{ url: string }>

getGuildAuditLogs

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

- Defined in node_modules/eris/index.d.ts:1563
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?: undefined | string; user: User }>

- Defined in node_modules/eris/index.d.ts:1564
Parameters
- guildID: string
- userID: string
Returns Promise<{ reason?: undefined | string; user: User }>

getGuildBans

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

- Defined in node_modules/eris/index.d.ts:1565
Parameters
- guildID: string
Returns Promise<{ reason?: undefined | string; user: User }[]>

getGuildDiscovery

getGuildDiscovery(guildID: string): Promise<DiscoveryMetadata>

- Defined in node_modules/eris/index.d.ts:1566
Parameters
- guildID: string
Returns Promise<DiscoveryMetadata>

getGuildEmbed

getGuildEmbed(guildID: string): Promise<Widget>

- Defined in node_modules/eris/index.d.ts:1568
deprecated

Parameters
- guildID: string
Returns Promise<Widget>

getGuildIntegrations

getGuildIntegrations(guildID: string, options?: GetGuildIntegrationsOptions): Promise<GuildIntegration[]>

- Defined in node_modules/eris/index.d.ts:1569
Parameters
- guildID: string
- Optional options: GetGuildIntegrationsOptions
Returns Promise<GuildIntegration[]>

getGuildInvites

getGuildInvites(guildID: string): Promise<Invite<"withMetadata", InviteChannel>[]>

- Defined in node_modules/eris/index.d.ts:1570
Parameters
- guildID: string
Returns Promise<Invite<"withMetadata", InviteChannel>[]>

getGuildPreview

getGuildPreview(guildID: string): Promise<GuildPreview>

- Defined in node_modules/eris/index.d.ts:1571
Parameters
- guildID: string
Returns Promise<GuildPreview>

getGuildTemplate

getGuildTemplate(code: string): Promise<GuildTemplate>

- Defined in node_modules/eris/index.d.ts:1572
Parameters
- code: string
Returns Promise<GuildTemplate>

getGuildTemplates

getGuildTemplates(guildID: string): Promise<GuildTemplate[]>

- Defined in node_modules/eris/index.d.ts:1573
Parameters
- guildID: string
Returns Promise<GuildTemplate[]>

getGuildVanity

getGuildVanity(guildID: string): Promise<{ code?: undefined | string; uses?: undefined | number }>

- Defined in node_modules/eris/index.d.ts:1574
Parameters
- guildID: string
Returns Promise<{ code?: undefined | string; uses?: undefined | number }>

getGuildWebhooks

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

- Defined in node_modules/eris/index.d.ts:1575
Parameters
- guildID: string
Returns Promise<Webhook[]>

getGuildWidget

getGuildWidget(guildID: string): Promise<Widget>

- Defined in node_modules/eris/index.d.ts:1576
Parameters
- guildID: string
Returns Promise<Widget>

getInvite

getInvite(inviteID: string, withCounts?: false): Promise<Invite<"withoutCount", InviteChannel>>
getInvite(inviteID: string, withCounts: true): Promise<Invite<"withCount", InviteChannel>>

- Defined in node_modules/eris/index.d.ts:1577
Parameters
- inviteID: string
- Optional withCounts: false
Returns Promise<Invite<"withoutCount", InviteChannel>>
- Defined in node_modules/eris/index.d.ts:1578
Parameters
- inviteID: string
- withCounts: true
Returns Promise<Invite<"withCount", InviteChannel>>

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/globals.d.ts:554
Returns number

getMessage

getMessage(channelID: string, messageID: string): Promise<Message<TextableChannel>>

- Defined in node_modules/eris/index.d.ts:1579
Parameters
- channelID: string
- messageID: string
Returns Promise<Message<TextableChannel>>

getMessageReaction

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

- Defined in node_modules/eris/index.d.ts:1580
Parameters
- channelID: string
- messageID: string
- reaction: string
- Optional limit: number
- Optional before: string
- Optional after: string
Returns Promise<User[]>

getMessages

getMessages(channelID: string, limit?: number, before?: string, after?: string, around?: string): Promise<Message<TextableChannel>[]>

- Defined in node_modules/eris/index.d.ts:1588
Parameters
- channelID: string
- Optional limit: number
- Optional before: string
- Optional after: string
- Optional around: string
Returns Promise<Message<TextableChannel>[]>

getOAuthApplication

getOAuthApplication(appID?: string): Promise<OAuthApplicationInfo>

- Defined in node_modules/eris/index.d.ts:1595
Parameters
- Optional appID: string
Returns Promise<OAuthApplicationInfo>

getPins

getPins(channelID: string): Promise<Message<TextableChannel>[]>

- Defined in node_modules/eris/index.d.ts:1596
Parameters
- channelID: string
Returns Promise<Message<TextableChannel>[]>

getPruneCount

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

- Defined in node_modules/eris/index.d.ts:1597
Parameters
- guildID: string
- Optional options: GetPruneOptions
Returns Promise<number>

getRESTChannel

getRESTChannel(channelID: string): Promise<AnyChannel>

- Defined in node_modules/eris/index.d.ts:1598
Parameters
- channelID: string
Returns Promise<AnyChannel>

getRESTGuild

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

- Defined in node_modules/eris/index.d.ts:1599
Parameters
- guildID: string
- Optional withCounts: boolean
Returns Promise<Guild>

getRESTGuildChannels

getRESTGuildChannels(guildID: string): Promise<AnyGuildChannel[]>

- Defined in node_modules/eris/index.d.ts:1600
Parameters
- guildID: string
Returns Promise<AnyGuildChannel[]>

getRESTGuildEmoji

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

- Defined in node_modules/eris/index.d.ts:1601
Parameters
- guildID: string
- emojiID: string
Returns Promise<Emoji>

getRESTGuildEmojis

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

- Defined in node_modules/eris/index.d.ts:1602
Parameters
- guildID: string
Returns Promise<Emoji[]>

getRESTGuildMember

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

- Defined in node_modules/eris/index.d.ts:1603
Parameters
- guildID: string
- memberID: string
Returns Promise<Member>

getRESTGuildMembers

getRESTGuildMembers(guildID: string, limit?: number, after?: string): Promise<Member[]>

- Defined in node_modules/eris/index.d.ts:1604
Parameters
- guildID: string
- Optional limit: number
- Optional after: string
Returns Promise<Member[]>

getRESTGuildRoles

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

- Defined in node_modules/eris/index.d.ts:1605
Parameters
- guildID: string
Returns Promise<Role[]>

getRESTGuilds

getRESTGuilds(limit?: number, before?: string, after?: string): Promise<Guild[]>

- Defined in node_modules/eris/index.d.ts:1606
Parameters
- Optional limit: number
- Optional before: string
- Optional after: string
Returns Promise<Guild[]>

getRESTUser

getRESTUser(userID: string): Promise<User>

- Defined in node_modules/eris/index.d.ts:1607
Parameters
- userID: string
Returns Promise<User>

getSelf

getSelf(): Promise<ExtendedUser>

- Defined in node_modules/eris/index.d.ts:1608
Returns Promise<ExtendedUser>

getSelfBilling

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

- Defined in node_modules/eris/index.d.ts:1609
Returns Promise<{ payment_gateway?: undefined | string; payment_source?: undefined | { brand: string; expires_month: number; expires_year: number; invalid: boolean; last_4: number; type: string }; premium_subscription?: undefined | { canceled_at?: undefined | string; created_at: string; current_period_end?: undefined | string; current_period_start?: undefined | string; ended_at?: undefined | string; plan: string; status: number } }>

getSelfConnections

getSelfConnections(): Promise<Connection[]>

- Defined in node_modules/eris/index.d.ts:1629
Returns Promise<Connection[]>

getSelfMFACodes

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

- Defined in node_modules/eris/index.d.ts:1630
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 }[]>

- Defined in node_modules/eris/index.d.ts:1634
Returns Promise<{ amount: number; amount_refunded: number; created_at: string; currency: string; description: string; status: number }[]>

getSelfSettings

getSelfSettings(): Promise<UserSettings>

- Defined in node_modules/eris/index.d.ts:1642
Returns Promise<UserSettings>

getUserProfile

getUserProfile(userID: string): Promise<UserProfile>

- Defined in node_modules/eris/index.d.ts:1643
Parameters
- userID: string
Returns Promise<UserProfile>

getVoiceRegions

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

- Defined in node_modules/eris/index.d.ts:1644
Parameters
- Optional guildID: string
Returns Promise<VoiceRegion[]>

getWebhook

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

- Defined in node_modules/eris/index.d.ts:1645
Parameters
- webhookID: string
- Optional token: string
Returns Promise<Webhook>

joinVoiceChannel

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

- Defined in node_modules/eris/index.d.ts:1646
Parameters
- channelID: string
- Optional options: { opusOnly?: undefined | boolean; shared?: undefined | boolean }
  - Optional opusOnly?: undefined | boolean
  - Optional shared?: undefined | boolean
Returns Promise<VoiceConnection>

kickGuildMember

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

- Defined in node_modules/eris/index.d.ts:1647
Parameters
- guildID: string
- userID: string
- Optional reason: string
Returns Promise<void>

leaveGuild

leaveGuild(guildID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1648
Parameters
- guildID: string
Returns Promise<void>

leaveVoiceChannel

leaveVoiceChannel(channelID: string): void

- Defined in node_modules/eris/index.d.ts:1649
Parameters
- channelID: string
Returns void

listenerCount

listenerCount(type: string | symbol): number

- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

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

- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
Returns Function[]

off

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

- Defined in node_modules/@types/node/globals.d.ts:551
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

- Defined in node_modules/@types/node/globals.d.ts:549
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>

- Defined in node_modules/eris/index.d.ts:1650
Parameters
- channelID: string
- messageID: string
Returns Promise<void>

prependListener

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

- Defined in node_modules/@types/node/globals.d.ts:560
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

- Defined in node_modules/@types/node/globals.d.ts:561
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

pruneMembers

pruneMembers(guildID: string, options?: PruneMemberOptions): Promise<number>

- Defined in node_modules/eris/index.d.ts:1651
Parameters
- guildID: string
- Optional options: PruneMemberOptions
Returns Promise<number>

purgeChannel

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

- Defined in node_modules/eris/index.d.ts:1652
Parameters
- channelID: string
- Optional limit: number
- Optional filter: (m: Message<GuildTextableChannel>) => boolean
  - - (m: Message<GuildTextableChannel>): boolean
    - Parameters
      - m: Message<GuildTextableChannel>
      Returns boolean
- Optional before: string
- Optional after: string
- Optional reason: string
Returns Promise<number>

rawListeners

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

- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Client

- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns Client

removeGroupRecipient

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

- Defined in node_modules/eris/index.d.ts:1660
Parameters
- groupID: string
- userID: string
Returns Promise<void>

removeGuildMemberRole

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

- Defined in node_modules/eris/index.d.ts:1661
Parameters
- guildID: string
- memberID: string
- roleID: string
- Optional reason: string
Returns Promise<void>

removeListener

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

- Defined in node_modules/@types/node/globals.d.ts:550
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>

- Defined in node_modules/eris/index.d.ts:1662
Parameters
- channelID: string
- messageID: string
- reaction: string
- Optional userID: string
Returns Promise<void>

removeMessageReactionEmoji

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

- Defined in node_modules/eris/index.d.ts:1663
Parameters
- channelID: string
- messageID: string
- reaction: string
Returns Promise<void>

removeMessageReactions

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

- Defined in node_modules/eris/index.d.ts:1664
Parameters
- channelID: string
- messageID: string
Returns Promise<void>

removeRelationship

removeRelationship(userID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1665
Parameters
- userID: string
Returns Promise<void>

searchChannelMessages

searchChannelMessages(channelID: string, query: SearchOptions): Promise<SearchResults>

- Defined in node_modules/eris/index.d.ts:1666
Parameters
- channelID: string
- query: SearchOptions
Returns Promise<SearchResults>

searchGuildMembers

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

- Defined in node_modules/eris/index.d.ts:1667
Parameters
- guildID: string
- query: string
- Optional limit: number
Returns Promise<Member[]>

searchGuildMessages

searchGuildMessages(guildID: string, query: SearchOptions): Promise<SearchResults>

- Defined in node_modules/eris/index.d.ts:1668
Parameters
- guildID: string
- query: SearchOptions
Returns Promise<SearchResults>

sendChannelTyping

sendChannelTyping(channelID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1669
Parameters
- channelID: string
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): Client

- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns Client

syncGuildIntegration

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

- Defined in node_modules/eris/index.d.ts:1670
Parameters
- guildID: string
- integrationID: string
Returns Promise<void>

syncGuildTemplate

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

- Defined in node_modules/eris/index.d.ts:1671
Parameters
- guildID: string
- code: string
Returns Promise<GuildTemplate>

toString

toString(): string

- Defined in node_modules/eris/index.d.ts:1676
Returns string

unbanGuildMember

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

- Defined in node_modules/eris/index.d.ts:1672
Parameters
- guildID: string
- userID: string
- Optional reason: string
Returns Promise<void>

unpinMessage

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

- Defined in node_modules/eris/index.d.ts:1673
Parameters
- channelID: string
- messageID: string
Returns Promise<void>

validateDiscoverySearchTerm

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

- Defined in node_modules/eris/index.d.ts:1674
Parameters
- term: string
Returns Promise<{ valid: boolean }>

Static listenerCount

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

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

token: string

Optional options: ClientOptions

Returns Client

Properties

Optional application

bot

channelGuildMap

Type declaration

[s: string]: string

Optional gatewayURL

groupChannels

guildShardMap

Type declaration

[s: string]: number

guilds

lastConnect

lastReconnectDelay

notes

Type declaration

[s: string]: string

on

options

presence

privateChannelMap

Type declaration

[s: string]: string

privateChannels

ready

reconnectAttempts

relationships

requestHandler

shards

startTime

unavailableGuilds

uptime

user

userGuildSettings

Type declaration

[s: string]: GuildSettings

userSettings

users

voiceConnections

Static defaultMaxListeners

Methods

acceptInvite

Parameters

inviteID: string

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

addGroupRecipient

Parameters

groupID: string

userID: string

Returns Promise<void>

addGuildDiscoverySubcategory

Parameters

guildID: string

categoryID: string

Optional reason: string

Returns Promise<DiscoverySubcategoryResponse>

addGuildMemberRole

Parameters

guildID: string

memberID: string

roleID: string

Optional reason: string

Returns Promise<void>

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]