• API Docs
• Handler
• Classes
• SparkClient

SparkClient extends Client<Ready>

new SparkClient(options)

Properties

public application: If<Ready, ClientApplication, null>

• Source

public channels: ChannelManager

• Source

public directories: Readonly<SparkClientDirectories>

The directories used for the handler.

• Source

public guilds: GuildManager

• Source

private logLevel: LogLevel

The log level used by the logger.

• Source

public logger: Logger

The logger to be used by the handler. Logger implemented by

• Source

public options: Omit<ClientOptions, 'intents'> & { intents: IntentsBitField }

• Source

public prefix: string

The prefix used for text commands. Defaults to '!'

• Source

public readyTimestamp: If<Ready, number, null>

• Source

public rest: REST

• Source

public shard: null | ShardClientUtil

• Source

public sweepers: Sweepers

• Source

public token: If<Ready, string, null | string>

• Source

public user: If<Ready, ClientUser, null>

• Source

public users: UserManager

• Source

public voice: ClientVoiceManager

• Source

public ws: WebSocketManager

• Source

public static captureRejectionSymbol: (typeof captureRejectionSymbol)

public static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

public static defaultMaxListeners: number

public static errorMonitor: (typeof errorMonitor)

This symbol shall be used to install a listener for only monitoring

public _censoredToken: null | string

public emojis: BaseGuildEmojiManager

public readyAt: If<Ready, Date, null>

public uptime: If<Ready, number, null>

Methods

public addListener(eventName, listener): SparkClient<Ready>

Alias for

public destroy(): void

• Source

public emit(event, args): boolean

• Source

public eventNames(): Array<string | symbol>

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or

public fetchGuildPreview(guild): Promise<GuildPreview>

• Source

public fetchGuildTemplate(template): Promise<GuildTemplate>

• Source

public fetchGuildWidget(guild): Promise<Widget>

• Source

public fetchInvite(invite, options?): Promise<Invite>

• Source

public fetchPremiumStickerPacks(): Promise<Collection<string, StickerPack>>

• Source

public fetchSticker(id): Promise<Sticker>

• Source

public fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>

• Source

public fetchWebhook(id, token?): Promise<Webhook>

• Source

public generateInvite(options?): string

• Source

public getMaxListeners(): number

Returns the current max listener value for the

public isReady(): this is Client<true>

• Source

public listenerCount(eventName): number

Returns the number of listeners listening to the event named

public listeners(eventName): Array<Function>

Returns a copy of the array of listeners for the event named

public login(token): Promise<string>

Registers the handler and logs into the bot. Usage:

• Source

public off(event, listener): SparkClient<Ready>

• Source

public on(event, listener): SparkClient<Ready>

• Source

public once(event, listener): SparkClient<Ready>

• Source

public prependListener(eventName, listener): SparkClient<Ready>

Adds the

public prependOnceListener(eventName, listener): SparkClient<Ready>

Adds a one-time

public rawListeners(eventName): Array<Function>

Returns a copy of the array of listeners for the event named

public removeAllListeners(event?): SparkClient<Ready>

• Source

public removeListener(eventName, listener): SparkClient<Ready>

Removes the specified

public setMaxListeners(n): SparkClient<Ready>

By default

public toJSON(): unknown

• Source

public static getEventListeners(emitter, name): Array<Function>

Returns a copy of the array of listeners for the event named

public static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given

• ⚠️ Deprecated

public static on(emitter, eventName, options?): AsyncIterableIterator<any>

const { on, EventEmitter } = require('events');
 
(async () => {
const ee = new EventEmitter();
 
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
 
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();

public static once(emitter, eventName, options?): Promise<Array<any>>

Creates a

public static setMaxListeners(n?, eventTargets): void

const {
setMaxListeners,
EventEmitter
} = require('events');
 
const target = new EventTarget();
const emitter = new EventEmitter();
 
setMaxListeners(5, target, emitter);