Client
Defined in: packages/core/src/index.ts:317
Main Lunibee Discord client.
Extends
Section titled “Extends”EventEmitter<ClientEvents>
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Client(
options):Client
Defined in: packages/core/src/index.ts:459
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Client
Overrides
Section titled “Overrides”EventEmitter<ClientEvents>.constructor
Properties
Section titled “Properties”application
Section titled “application”
readonlyapplication:object
Defined in: packages/core/src/index.ts:327
commands
Section titled “commands”commands:
ApplicationCommandManager
applicationEmojis?
Section titled “applicationEmojis?”
optionalapplicationEmojis?:ApplicationEmojiManager
Defined in: packages/core/src/index.ts:341
The application’s own emojis; available after READY (application ID known).
channels
Section titled “channels”
readonlychannels:ChannelManager
Defined in: packages/core/src/index.ts:324
commands
Section titled “commands”
readonlycommands:CommandRegistry
Defined in: packages/core/src/index.ts:337
Slash and prefix commands made with command(): add, deploy and listen.
guilds
Section titled “guilds”
readonlyguilds:GuildManager
Defined in: packages/core/src/index.ts:323
monetization?
Section titled “monetization?”
optionalmonetization?:MonetizationManager
Defined in: packages/core/src/index.ts:339
SKUs, entitlements and subscriptions; available after READY (application ID known).
options
Section titled “options”
readonlyoptions:ClientOptions
Defined in: packages/core/src/index.ts:459
readyAt?
Section titled “readyAt?”
optionalreadyAt?:Date
Defined in: packages/core/src/index.ts:355
readonlyrest:REST
Defined in: packages/core/src/index.ts:321
stageInstances
Section titled “stageInstances”
readonlystageInstances:StageInstanceManager
Defined in: packages/core/src/index.ts:326
Stage instances, cached by stage channel ID.
state:
ClientState="idle"
Defined in: packages/core/src/index.ts:356
optionaluser?:UserData
Defined in: packages/core/src/index.ts:348
readonlyusers:UserManager
Defined in: packages/core/src/index.ts:322
readonlyvoice:VoiceManager
Defined in: packages/core/src/index.ts:354
Voice connections, one per guild: await bot.voice.join({ guildId, channelId }) resolves when audio can flow. Fed by this client’s own
VOICE_STATE_UPDATE and VOICE_SERVER_UPDATE events.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get api():
Api
Defined in: packages/core/src/index.ts:333
Discord’s REST API as a chained path: bot.api.guilds(id).members(userId).patch({ nick }).
Uses this client’s rate limiting and retries; bot.rest and Routes stay available.
Returns
Section titled “Returns”gateway
Section titled “gateway”Get Signature
Section titled “Get Signature”get gateway():
Gateway
Defined in: packages/core/src/index.ts:345
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get ping():
number
Defined in: packages/core/src/index.ts:374
Returns
Section titled “Returns”number
resourceContext
Section titled “resourceContext”Get Signature
Section titled “Get Signature”get resourceContext():
ResourceContext
Defined in: packages/core/src/index.ts:1458
Structures built by this client (members from interactions…) act through this.
Returns
Section titled “Returns”Lets structures built from an interaction (such as Interaction.member) act through the client. Optional.
Implementation of
Section titled “Implementation of”InteractionClient.resourceContext
Get Signature
Section titled “Get Signature”get token():
string|null
Defined in: packages/core/src/index.ts:368
Returns
Section titled “Returns”string | null
uptime
Section titled “uptime”Get Signature
Section titled “Get Signature”get uptime():
number|null
Defined in: packages/core/src/index.ts:371
Returns
Section titled “Returns”number | null
Get Signature
Section titled “Get Signature”get ws():
Gateway
Defined in: packages/core/src/index.ts:342
Returns
Section titled “Returns”Methods
Section titled “Methods”channel()
Section titled “channel()”channel(
id):ChannelHandle
Defined in: packages/core/src/index.ts:1434
Names a channel by id; see Client.guild for the read methods.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”createCollector()
Section titled “createCollector()”createCollector<
E>(event,options?):Collector<string,ClientEvents[E][0]>
Defined in: packages/core/src/index.ts:1392
Collects the first argument of a client event until a limit, timeout,
idle timeout, abort or stop(). The collector unsubscribes itself when
it ends. Items are keyed by options.key, else their id, else order.
Type Parameters
Section titled “Type Parameters”E extends keyof ClientEvents
Parameters
Section titled “Parameters”E
options?
Section titled “options?”CollectorOptions<ClientEvents[E][0]> & object = {}
Returns
Section titled “Returns”Collector<string, ClientEvents[E][0]>
deleteInteractionReply()
Section titled “deleteInteractionReply()”deleteInteractionReply(
token,applicationId?):Promise<void>
Defined in: packages/core/src/index.ts:1649
Deletes the original interaction response.
Parameters
Section titled “Parameters”string
Interaction token.
applicationId?
Section titled “applicationId?”string
The interaction’s application_id.
Returns
Section titled “Returns”Promise<void>
Promise fulfilled after deletion.
Throws
Section titled “Throws”When REST fails.
Implementation of
Section titled “Implementation of”InteractionClient.deleteInteractionReply
destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/core/src/index.ts:1591
Destroys the client, permanently closing the Gateway connection.
Returns
Section titled “Returns”void
editInteractionReply()
Section titled “editInteractionReply()”editInteractionReply(
token,data,applicationId?):Promise<unknown>
Defined in: packages/core/src/index.ts:1632
Edits the original interaction response.
Parameters
Section titled “Parameters”string
Interaction token.
Record<string, unknown>
Message payload.
applicationId?
Section titled “applicationId?”string
The interaction’s application_id, which the webhook route needs.
Returns
Section titled “Returns”Promise<unknown>
Discord response.
Throws
Section titled “Throws”When REST fails.
Implementation of
Section titled “Implementation of”InteractionClient.editInteractionReply
fetchDefaultSoundboardSounds()
Section titled “fetchDefaultSoundboardSounds()”fetchDefaultSoundboardSounds():
Promise<APISoundboardSound[]>
Defined in: packages/core/src/index.ts:1530
Fetches Discord’s default soundboard sounds.
Returns
Section titled “Returns”Promise<APISoundboardSound[]>
fetchGuildPreview()
Section titled “fetchGuildPreview()”fetchGuildPreview(
guildId):Promise<Record<string,unknown>>
Defined in: packages/core/src/index.ts:1707
Fetches a guild preview from Discord.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<Record<string, unknown>>
fetchGuildTemplate()
Section titled “fetchGuildTemplate()”fetchGuildTemplate(
code):Promise<Record<string,unknown>>
Defined in: packages/core/src/index.ts:1758
Fetches a guild template from Discord.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Record<string, unknown>>
fetchInvite()
Section titled “fetchInvite()”fetchInvite(
code,options?):Promise<Record<string,unknown>>
Defined in: packages/core/src/index.ts:1723
Fetches an invite from Discord.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”guildScheduledEventId?
Section titled “guildScheduledEventId?”string
withCounts?
Section titled “withCounts?”boolean
Returns
Section titled “Returns”Promise<Record<string, unknown>>
fetchPremiumStickerPacks()
Section titled “fetchPremiumStickerPacks()”fetchPremiumStickerPacks():
Promise<Record<string,unknown>>
Defined in: packages/core/src/index.ts:1751
Fetches premium sticker packs from Discord.
Returns
Section titled “Returns”Promise<Record<string, unknown>>
fetchSticker()
Section titled “fetchSticker()”fetchSticker(
id):Promise<Record<string,unknown>>
Defined in: packages/core/src/index.ts:1744
Fetches a sticker from Discord.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Record<string, unknown>>
fetchVoiceRegions()
Section titled “fetchVoiceRegions()”fetchVoiceRegions():
Promise<Record<string,unknown>[]>
Defined in: packages/core/src/index.ts:1716
Fetches the voice regions from Discord.
Returns
Section titled “Returns”Promise<Record<string, unknown>[]>
fetchWebhook()
Section titled “fetchWebhook()”fetchWebhook(
id,token?):Promise<Record<string,unknown>>
Defined in: packages/core/src/index.ts:1697
Fetches a webhook from Discord.
Parameters
Section titled “Parameters”string
token?
Section titled “token?”string
Returns
Section titled “Returns”Promise<Record<string, unknown>>
followUpInteraction()
Section titled “followUpInteraction()”followUpInteraction(
token,data,applicationId?):Promise<unknown>
Defined in: packages/core/src/index.ts:1660
Sends a follow-up interaction webhook message.
Parameters
Section titled “Parameters”string
Interaction token.
Record<string, unknown>
Message payload.
applicationId?
Section titled “applicationId?”string
The interaction’s application_id.
Returns
Section titled “Returns”Promise<unknown>
Discord response.
Throws
Section titled “Throws”When REST fails.
Implementation of
Section titled “Implementation of”InteractionClient.followUpInteraction
generateInvite()
Section titled “generateInvite()”generateInvite(
options?):string
Defined in: packages/core/src/index.ts:1765
Generates an invite link for this client.
Parameters
Section titled “Parameters”options?
Section titled “options?”permissions?
Section titled “permissions?”string | bigint
scopes?
Section titled “scopes?”string[]
Returns
Section titled “Returns”string
guild()
Section titled “guild()”guild(
id):GuildHandle
Defined in: packages/core/src/index.ts:1430
Names a guild by id. The handle reads it (peek() from the cache, get()
from the cache or Discord, fetch() from Discord) and acts on it.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”interactionWebhookMessage()
Section titled “interactionWebhookMessage()”interactionWebhookMessage(
method,applicationId,token,messageId,data?):Promise<unknown>
Defined in: packages/core/src/index.ts:1671
Reads, edits or deletes an interaction webhook message (@original or a follow-up ID). Optional; required for Interaction.fetchReply, Interaction.editFollowUp and Interaction.deleteFollowUp.
Parameters
Section titled “Parameters”method
Section titled “method”"GET" | "PATCH" | "DELETE"
applicationId
Section titled “applicationId”string
string
messageId
Section titled “messageId”string
Record<string, unknown>
Returns
Section titled “Returns”Promise<unknown>
Implementation of
Section titled “Implementation of”InteractionClient.interactionWebhookMessage
isReady()
Section titled “isReady()”isReady():
boolean
Defined in: packages/core/src/index.ts:378
Whether the client is ready and connected.
Returns
Section titled “Returns”boolean
listenerCount()
Section titled “listenerCount()”listenerCount<
K>(event):number
Defined in: packages/core/src/index.ts:225
Number of listeners for event, as Node’s EventEmitter reports it.
Type Parameters
Section titled “Type Parameters”K extends keyof ClientEvents
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
login()
Section titled “login()”login(
token?):Promise<string>
Defined in: packages/core/src/index.ts:1540
Connects to the Gateway. Resolves with the token used; do not log the return value.
Parameters
Section titled “Parameters”token?
Section titled “token?”string
Returns
Section titled “Returns”Promise<string>
member()
Section titled “member()”member(
guildId,userId):MemberHandle
Defined in: packages/core/src/index.ts:1445
Names a guild member by guild id and user id.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
userId
Section titled “userId”string
Returns
Section titled “Returns”message()
Section titled “message()”message(
channelId,messageId):MessageHandle
Defined in: packages/core/src/index.ts:1453
Names a message by channel id and message id.
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
messageId
Section titled “messageId”string
Returns
Section titled “Returns”off<
K>(event,listener):this
Defined in: packages/core/src/index.ts:210
Type Parameters
Section titled “Type Parameters”K extends keyof ClientEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Listener<ClientEvents[K]>
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on<
K>(event,listener):this
Defined in: packages/core/src/index.ts:191
Type Parameters
Section titled “Type Parameters”K extends keyof ClientEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Listener<ClientEvents[K]>
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once<
K>(event,listener):this
Defined in: packages/core/src/index.ts:200
Type Parameters
Section titled “Type Parameters”K extends keyof ClientEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Listener<ClientEvents[K]>
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
permissionsFor()
Section titled “permissionsFor()”permissionsFor(
memberId,guildOrChannelId):PermissionSet|null
Defined in: packages/core/src/index.ts:1498
Resolves a member’s permissions from cached state: guild-level for a guild ID, or channel-level (including overwrites) for a cached channel ID. Returns null when the guild or member is not cached.
Parameters
Section titled “Parameters”memberId
Section titled “memberId”string
guildOrChannelId
Section titled “guildOrChannelId”string
Returns
Section titled “Returns”PermissionSet | null
person()
Section titled “person()”person(
id):UserHandle
Defined in: packages/core/src/index.ts:1441
Names a user by id; see Client.guild for the read methods.
(bot.user is the bot’s own account, hence the different name.)
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”postInteractionResponse()
Section titled “postInteractionResponse()”postInteractionResponse(
id,token,response):Promise<unknown>
Defined in: packages/core/src/index.ts:1607
Sends the initial interaction callback.
Parameters
Section titled “Parameters”string
Interaction identifier.
string
Interaction token.
response
Section titled “response”Callback payload.
Returns
Section titled “Returns”Promise<unknown>
Discord response.
Throws
Section titled “Throws”When REST fails.
Implementation of
Section titled “Implementation of”InteractionClient.postInteractionResponse
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners<
K>(event?):this
Defined in: packages/core/src/index.ts:228
Type Parameters
Section titled “Type Parameters”K extends keyof ClientEvents
Parameters
Section titled “Parameters”event?
Section titled “event?”K
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener<
K>(event,listener):this
Defined in: packages/core/src/index.ts:218
Alias of off, provided for Node.js EventEmitter familiarity.
Type Parameters
Section titled “Type Parameters”K extends keyof ClientEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Listener<ClientEvents[K]>
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
requestGuildMembers()
Section titled “requestGuildMembers()”requestGuildMembers(
data):boolean
Defined in: packages/core/src/index.ts:442
Requests guild members.
Parameters
Section titled “Parameters”Record<string, unknown>
Guild member request payload.
Returns
Section titled “Returns”boolean
Whether it was sent.
role()
Section titled “role()”role(
guildId,roleId):RoleHandle
Defined in: packages/core/src/index.ts:1449
Names a role by guild id and role id.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
roleId
Section titled “roleId”string
Returns
Section titled “Returns”sendVoiceState()
Section titled “sendVoiceState()”sendVoiceState(
guildId,channelId,options?):boolean
Defined in: packages/core/src/index.ts:434
Joins, moves or leaves a voice channel (op 4). Stable public voice API.
Returns false (never throws) when disconnected, rate limited, or when
the guild belongs to another shard of a sharded setup.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Guild snowflake.
channelId
Section titled “channelId”string | null
Channel to join or move to; null leaves.
options?
Section titled “options?”selfMute and selfDeaf.
selfDeaf?
Section titled “selfDeaf?”boolean
selfMute?
Section titled “selfMute?”boolean
Returns
Section titled “Returns”boolean
Whether it was sent.
setActivity()
Section titled “setActivity()”setActivity(
name,options?):boolean
Defined in: packages/core/src/index.ts:394
Sets what the bot is doing: “Playing chess”, “Watching the logs”. Pass
null to clear it. For a custom status (type ActivityEnum.Custom) the
text shown is state, so it is set to name unless you give one.
Parameters
Section titled “Parameters”string | null
options?
Section titled “options?”state?
Section titled “state?”string
status?
Section titled “status?”"online" | "dnd" | "idle" | "invisible" | "offline"
string
Returns
Section titled “Returns”boolean
Whether the update was sent (false while the Gateway is not connected).
Example
Section titled “Example”bot.setActivity("the logs", { type: ActivityEnum.Watching, status: "idle" });setPresence()
Section titled “setPresence()”setPresence(
data):boolean
Defined in: packages/core/src/index.ts:382
Sets the bot’s presence / status.
Parameters
Section titled “Parameters”Presence payload.
Returns
Section titled “Returns”boolean
Whether the payload was sent.
setVoiceState()
Section titled “setVoiceState()”setVoiceState(
data):boolean
Defined in: packages/core/src/index.ts:424
Sends a voice state update.
Parameters
Section titled “Parameters”Record<string, unknown>
Voice state payload.
Returns
Section titled “Returns”boolean
Whether it was sent.