Class default

Hierarchy

TypedEmitter<ClientEvents>
- default

Implements

Client

Constructors

constructor

new default(options: ClientOptions): default
Creates the client and sets the default options.
Parameters
- options: ClientOptions
 The options to pass to the client.
 - cacheMessages
 Whether to cache messages.
 - cacheUsers
 Whether to cache users.
 - cacheMembers
 Whether to cache members.
 - cacheChannels
 Whether to cache channels.
 - cacheGuilds
 Whether to cache guilds.
 - cacheVoiceStates
 Whether to cache voice states.
 - cacheRoles
 Whether to cache roles.
 - cacheScheduledEvents
 Whether to cache scheduled events.
 - cacheEmojis
 Whether to cache emojis.
 - cacheInvites
 Whether to cache invites.
 - defaultMessageExpiry
 The default expiry time for messages.
 - defaultUserExpiry
 The default expiry time for users.
 - intents
 The intents to use when connecting.
 - totalShards
 The total number of shards to manage.
 - shardIds
 The ids of the shards to manage.
 - sessionData
 The session data for the client.
 - initCache
 The initial cache data for the client.
 - softRestartFunction
 The function to call when a soft restart is needed.
Returns default
Throws
Method
Overrides TypedEmitter<ClientEvents>.constructor
- Defined in src/Client.ts:95

Properties

`Readonly`_cacheOptions

_cacheOptions: GluonCacheOptions

`Readonly`_defaultGuildCacheOptions

_defaultGuildCacheOptions: GuildCacheOptions

request

request: any

`Static`defaultMaxListeners

defaultMaxListeners: number

Accessors

guilds

get guilds(): GuildManager
The guild manager for this client.

Returns GuildManager
Implementation of ClientType.guilds
- Defined in src/Client.ts:322

initialized

get initialized(): boolean
Returns boolean
Implementation of ClientType.initialized
- Defined in src/Client.ts:491

intents

get intents(): number
The intents that this client is using.

Returns number
Implementation of ClientType.intents
- Defined in src/Client.ts:289

ready

get ready(): boolean
Returns boolean
Implementation of ClientType.ready
- Defined in src/Client.ts:495

sessionData

get sessionData(): any[]
The session data for this client.

Returns any[]
Implementation of ClientType.sessionData
- Defined in src/Client.ts:332

shardIds

get shardIds(): number[]
The ids of the shards that this client is managing.

Returns number[]
Implementation of ClientType.shardIds
- Defined in src/Client.ts:259

totalShards

get totalShards(): number
The total number of shards that this client is managing.

Returns number
Implementation of ClientType.totalShards
- Defined in src/Client.ts:274

user

get user(): User
Returns User
Implementation of ClientType.user
- Defined in src/Client.ts:293
set user(user: User): void
Parameters
- user: User
Returns void
Implementation of ClientType.user
- Defined in src/Client.ts:302

users

get users(): UserManager
The user manager for this client.

Returns UserManager
Implementation of ClientType.users
- Defined in src/Client.ts:312

Methods

_emitDebug

_emitDebug(status: GluonDebugLevels, message: string): void
Outputs a debug message if NODE_ENV=development.
Parameters
- status: GluonDebugLevels
  The debug status level.
- message: string
  The message to emit.
Returns void
Method
Implementation of ClientType._emitDebug
- Defined in src/Client.ts:397

addListener

addListener(
event: U,
listener: ClientEvents[U],
): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.addListener
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

bundleCache

bundleCache(): GuildCacheJSON[]
Bundles all guilds.

Returns GuildCacheJSON[]
Method
Implementation of ClientType.bundleCache
- Defined in src/Client.ts:521

checkProcess

checkProcess(): ClientProcessData
Monitors the current process.

Returns ClientProcessData
Method
Implementation of ClientType.checkProcess
- Defined in src/Client.ts:366

createEmoji

createEmoji(emoji: { image: string; name: string }): Promise<any>
Creates an emoji for this client.
Parameters
- emoji: { image: string; name: string }
 The emoji to create.
 - image: string
 The image of the emoji (base64, should start with "data:image/png;base64,").
 - name: string
 The name of the emoji.
Returns Promise<any>
Method
Async
Throws
Implementation of ClientType.createEmoji
- Defined in src/Client.ts:580

emit

emit(
event: U,
...args: Parameters<ClientEvents[U]>,
): boolean
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- ...args: Parameters<ClientEvents[U]>
Returns boolean
Implementation of ClientType.emit
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof ClientEvents
Returns U[]
Implementation of ClientType.eventNames
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

fetchEmojis

fetchEmojis(): Promise<APIEmoji[]>
Fetches the emojis for this client.

Returns Promise<APIEmoji[]>
Method
Async
Implementation of ClientType.fetchEmojis
- Defined in src/Client.ts:565

getCacheCounts

getCacheCounts(): ClientCacheCounts
Counts how many items are in each cache.

Returns ClientCacheCounts
Method
Implementation of ClientType.getCacheCounts
- Defined in src/Client.ts:443

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of ClientType.getMaxListeners
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24

getMemberCount

getMemberCount(): number
Counts how many members are in all of Quark's servers.

Returns number
Method
Implementation of ClientType.getMemberCount
- Defined in src/Client.ts:505

halt

halt(): void
Stops all shards.

Returns void
Method
Implementation of ClientType.halt
- Defined in src/Client.ts:356

listenerCount

listenerCount(type: keyof ClientEvents): number
Parameters
- type: keyof ClientEvents
Returns number
Implementation of ClientType.listenerCount
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type: U): ClientEvents[U][]
Type Parameters
- U extends keyof ClientEvents
Parameters
- type: U
Returns ClientEvents[U][]
Implementation of ClientType.listeners
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

login(token: string): void
Initiates the login sequence
Parameters
- token: string
  The authorization token
Returns void
Method
Throws
Implementation of ClientType.login
- Defined in src/Client.ts:654

off

off(event: U, listener: ClientEvents[U]): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.off
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(event: U, listener: ClientEvents[U]): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.on
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(event: U, listener: ClientEvents[U]): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.once
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener(
event: U,
listener: ClientEvents[U],
): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.prependListener
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(
event: U,
listener: ClientEvents[U],
): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.prependOnceListener
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(type: U): ClientEvents[U][]
Type Parameters
- U extends keyof ClientEvents
Parameters
- type: U
Returns ClientEvents[U][]
Implementation of ClientType.rawListeners
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

registerCommands

registerCommands(commands: CommandBuilder[]): Promise<any>
Registers commands, overwriting all previous ones.
Parameters
- commands: CommandBuilder[]
 Array of commands to register.
Returns Promise<any>
See
- https://discord.com/developers/docs/interactions/application-commands#registering-a-command
- https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands
Method
Async
Throws
Implementation of ClientType.registerCommands
- Defined in src/Client.ts:536

removeAllListeners

removeAllListeners(event?: keyof ClientEvents): this
Parameters
- Optionalevent: keyof ClientEvents
Returns this
Implementation of ClientType.removeAllListeners
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(
event: U,
listener: ClientEvents[U],
): this
Type Parameters
- U extends keyof ClientEvents
Parameters
- event: U
- listener: ClientEvents[U]
Returns this
Implementation of ClientType.removeListener
Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14

setInitialized

setInitialized(): void
Returns void
Implementation of ClientType.setInitialized
- Defined in src/Client.ts:598

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Implementation of ClientType.setMaxListeners
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25

setReady

setReady(): void
Returns void
Implementation of ClientType.setReady
- Defined in src/Client.ts:602

setStatus

setStatus(
    status: {
        afk?: boolean;
        name: string;
        since?: number;
        status?: string;
        type?: number;
    },
): void
Sets the bot's status across all shards.
Parameters
- status: { afk?: boolean; name: string; since?: number; status?: string; type?: number }
  Status options.
  - Optionalafk?: boolean
    Whether the bot is afk.
  - name: string
    The bot's new status.
  - Optionalsince?: number
    The time since the bot has been afk.
  - Optionalstatus?: string
    The bot's status.
  - Optionaltype?: number
    The type of status.
Returns void
Method
Throws
Implementation of ClientType.setStatus
- Defined in src/Client.ts:619

softRestartFunction

softRestartFunction(): void
The function to call when a soft restart is needed.

Returns void
Method
Implementation of ClientType.softRestartFunction
- Defined in src/Client.ts:342

Class default

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

cacheMessages

cacheUsers

cacheMembers

cacheChannels

cacheGuilds

cacheVoiceStates

cacheRoles

cacheScheduledEvents

cacheEmojis

cacheInvites

defaultMessageExpiry

defaultUserExpiry

intents

totalShards

shardIds

sessionData

initCache

softRestartFunction

Returns default

Throws

Method

Properties

Readonly_cacheOptions

Readonly_defaultGuildCacheOptions

request

StaticdefaultMaxListeners

Accessors

guilds

Returns GuildManager

initialized

Returns boolean

intents

Returns number

ready

Returns boolean

sessionData

Returns any[]

shardIds

Returns number[]

totalShards

Returns number

user

Returns User

Parameters

Returns void

users

Returns UserManager

Methods

_emitDebug

Parameters

Returns void

Method

addListener

Type Parameters

Parameters

Returns this

bundleCache

Returns GuildCacheJSON[]

Method

checkProcess

Returns ClientProcessData

Method

createEmoji

Parameters

image: string

name: string

Returns Promise<any>

Method

Async

`Readonly`_cacheOptions

`Readonly`_defaultGuildCacheOptions

`Static`defaultMaxListeners