CreateBotOptions

@discordeno/bot • Docs

Documentation / @discordeno/bot / CreateBotOptions

Interface: CreateBotOptions<TProps, TBehavior>

Type Parameters

• TProps extends RecursivePartial<TransformersDesiredProperties>

• TBehavior extends DesiredPropertiesBehavior

Properties

applicationId?

optional applicationId: BigString

Application Id of the bot incase it is an old bot token.

Defined in

packages/bot/src/bot.ts:106

desiredProperties?

optional desiredProperties: TProps

Set the desired properties for the bot

Default

{}

Defined in

packages/bot/src/bot.ts:124

desiredPropertiesBehavior?

optional desiredPropertiesBehavior: TBehavior

Set the desired properties behavior for undesired properties

Default

DesiredPropertiesBehavior.RemoveKey

Defined in

packages/bot/src/bot.ts:130

events?

optional events: Partial<EventHandlers<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>>

The event handlers.

Defined in

packages/bot/src/bot.ts:114

gateway?

optional gateway: Omit<CreateGatewayManagerOptions, "token"> & Partial<Pick<CreateGatewayManagerOptions, "token">>

Any options you wish to provide to the gateway manager.

Defined in

packages/bot/src/bot.ts:112

handlers?

optional handlers: Partial<Record<GatewayDispatchEventNames, BotGatewayHandler<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>>

The handler functions that should handle incoming discord payloads from gateway and call an event.

Defined in

packages/bot/src/bot.ts:118

intents?

optional intents: GatewayIntents

The bot's intents that will be used to make a connection with discords gateway.

Defined in

packages/bot/src/bot.ts:108

loggerFactory()?

optional loggerFactory: (name) => Pick<object, "debug" | "info" | "warn" | "error" | "fatal">

This factory will be invoked to create the logger for gateway, rest and bot

Parameters

• name: "REST" | "GATEWAY" | "BOT"

Returns

Pick<object, "debug" | "info" | "warn" | "error" | "fatal">

debug()

debug: (...args) => void

Parameters

• ...args: any[]

Returns

void

error()

error: (...args) => void

Parameters

• ...args: any[]

Returns

void

fatal()

fatal: (...args) => void

Parameters

• ...args: any[]

Returns

void

info()

info: (...args) => void

Parameters

• ...args: any[]

Returns

void

log()

log: (level, ...args) => void

Parameters

• level: LogLevels

• ...args: any[]

Returns

void

setDepth()

setDepth: (level) => void

Parameters

• level: LogDepth

Returns

void

setLevel()

setLevel: (level) => void

Parameters

• level: LogLevels

Returns

void

warn()

warn: (...args) => void

Parameters

• ...args: any[]

Returns

void

Remarks

If not provided the default logger will be used with rest and gateway sharing the same logger

This function will be invoked 3 times, one with the name of REST, one with GATEWAY and the third one with name BOT

Defined in

packages/bot/src/bot.ts:139

rest?

optional rest: Omit<CreateRestManagerOptions, "token"> & Partial<Pick<CreateRestManagerOptions, "token">>

Any options you wish to provide to the rest manager.

Defined in

packages/bot/src/bot.ts:110

token

token: string

The bot's token.

Defined in

packages/bot/src/bot.ts:104

transformers?

optional transformers: object

The functions that should transform discord objects to discordeno shaped objects.

activity()?

optional activity: (bot, payload) => Activity

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordActivity

Returns

Activity

activityInstance()?

optional activityInstance: (bot, payload) => SetupDesiredProps<ActivityInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordActivityInstance

Returns

SetupDesiredProps<ActivityInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

activityLocation()?

optional activityLocation: (bot, payload) => SetupDesiredProps<ActivityLocation, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordActivityLocation

Returns

SetupDesiredProps<ActivityLocation, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

application()?

optional application: (bot, payload) => Application

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.application: DiscordApplication

• payload.shardId: number

Returns

Application

applicationCommand()?

optional applicationCommand: (bot, payload) => ApplicationCommand

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplicationCommand

Returns

ApplicationCommand

applicationCommandOption()?

optional applicationCommandOption: (bot, payload) => ApplicationCommandOption

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplicationCommandOption

Returns

ApplicationCommandOption

applicationCommandOptionChoice()?

optional applicationCommandOptionChoice: (bot, payload) => ApplicationCommandOptionChoice

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplicationCommandOptionChoice

Returns

ApplicationCommandOptionChoice

applicationCommandPermission()?

optional applicationCommandPermission: (bot, payload) => GuildApplicationCommandPermissions

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildApplicationCommandPermissions

Returns

GuildApplicationCommandPermissions

attachment()?

optional attachment: (bot, payload) => SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAttachment

Returns

SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

auditLogEntry()?

optional auditLogEntry: (bot, payload) => AuditLogEntry

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAuditLogEntry

Returns

AuditLogEntry

automodActionExecution()?

optional automodActionExecution: (bot, payload) => AutoModerationActionExecution

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAutoModerationActionExecution

Returns

AutoModerationActionExecution

automodRule()?

optional automodRule: (bot, payload) => AutoModerationRule

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAutoModerationRule

Returns

AutoModerationRule

avatarDecorationData()?

optional avatarDecorationData: (bot, payload) => SetupDesiredProps<AvatarDecorationData, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAvatarDecorationData

Returns

SetupDesiredProps<AvatarDecorationData, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

channel()?

optional channel: (bot, payload) => SetupDesiredProps<Channel, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.channel: DiscordChannel

• payload.guildId?: BigString

Returns

SetupDesiredProps<Channel, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

component()?

optional component: (bot, payload) => Component

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageComponent

Returns

Component

customizers?

optional customizers: object

customizers.activity()?

optional customizers.activity: (bot, payload, activity) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordActivity

• activity: Activity

Returns

any

customizers.activityInstance()?

optional customizers.activityInstance: (bot, payload, activityInstance) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordActivityInstance

• activityInstance: SetupDesiredProps<ActivityInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.activityLocation()?

optional customizers.activityLocation: (bot, payload, activityLocation) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordActivityLocation

• activityLocation: SetupDesiredProps<ActivityLocation, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.application()?

optional customizers.application: (bot, payload, application) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplication

• application: Application

Returns

any

customizers.applicationCommand()?

optional customizers.applicationCommand: (bot, payload, applicationCommand) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplicationCommand

• applicationCommand: ApplicationCommand

Returns

any

customizers.applicationCommandOption()?

optional customizers.applicationCommandOption: (bot, payload, applicationCommandOption) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplicationCommandOption

• applicationCommandOption: ApplicationCommandOption

Returns

any

customizers.applicationCommandOptionChoice()?

optional customizers.applicationCommandOptionChoice: (bot, payload, applicationCommandOptionChoice) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordApplicationCommandOptionChoice

• applicationCommandOptionChoice: ApplicationCommandOptionChoice

Returns

any

customizers.applicationCommandPermission()?

optional customizers.applicationCommandPermission: (bot, payload, applicationCommandPermission) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildApplicationCommandPermissions

• applicationCommandPermission: GuildApplicationCommandPermissions

Returns

any

customizers.attachment()?

optional customizers.attachment: (bot, payload, attachment) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAttachment

• attachment: SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.auditLogEntry()?

optional customizers.auditLogEntry: (bot, payload, auditLogEntry) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAuditLogEntry

• auditLogEntry: AuditLogEntry

Returns

any

customizers.automodActionExecution()?

optional customizers.automodActionExecution: (bot, payload, automodActionExecution) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAutoModerationActionExecution

• automodActionExecution: AutoModerationActionExecution

Returns

any

customizers.automodRule()?

optional customizers.automodRule: (bot, payload, automodRule) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAutoModerationRule

• automodRule: AutoModerationRule

Returns

any

customizers.avatarDecorationData()?

optional customizers.avatarDecorationData: (bot, payload, avatarDecorationData) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordAvatarDecorationData

• avatarDecorationData: SetupDesiredProps<AvatarDecorationData, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.channel()?

optional customizers.channel: (bot, payload, channel) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordChannel

• channel: SetupDesiredProps<Channel, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.component()?

optional customizers.component: (bot, payload, component) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageComponent

• component: Component

Returns

any

customizers.defaultReactionEmoji()?

optional customizers.defaultReactionEmoji: (bot, payload, defaultReactionEmoji) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordDefaultReactionEmoji

• defaultReactionEmoji: SetupDesiredProps<DefaultReactionEmoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.embed()?

optional customizers.embed: (bot, payload, embed) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordEmbed

• embed: Embed

Returns

any

customizers.emoji()?

optional customizers.emoji: (bot, payload, emoji) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordEmoji

• emoji: SetupDesiredProps<Emoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.entitlement()?

optional customizers.entitlement: (bot, payload, entitlement) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordEntitlement

• entitlement: SetupDesiredProps<Entitlement, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.forumTag()?

optional customizers.forumTag: (bot, payload, forumTag) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordForumTag

• forumTag: SetupDesiredProps<ForumTag, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.gatewayBot()?

optional customizers.gatewayBot: (bot, payload, getGatewayBot) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGetGatewayBot

• getGatewayBot: GetGatewayBot

Returns

any

customizers.guild()?

optional customizers.guild: (bot, payload, guild) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuild

• guild: SetupDesiredProps<Guild, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.guildOnboarding()?

optional customizers.guildOnboarding: (bot, payload, onboarding) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildOnboarding

• onboarding: SetupDesiredProps<GuildOnboarding, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.guildOnboardingPrompt()?

optional customizers.guildOnboardingPrompt: (bot, payload, onboardingPrompt) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildOnboardingPrompt

• onboardingPrompt: SetupDesiredProps<GuildOnboardingPrompt, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.guildOnboardingPromptOption()?

optional customizers.guildOnboardingPromptOption: (bot, payload, onboardingPromptOption) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildOnboardingPromptOption

• onboardingPromptOption: GuildOnboardingPromptOption

Returns

any

customizers.integration()?

optional customizers.integration: (bot, payload, integration) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordIntegrationCreateUpdate

• integration: Integration

Returns

any

customizers.interaction()?

optional customizers.interaction: (bot, payload, interaction) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.interaction: DiscordInteraction

• payload.shardId: number

• interaction: SetupDesiredProps<Interaction, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.interactionCallback()?

optional customizers.interactionCallback: (bot, payload, interactionCallback) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInteractionCallback

• interactionCallback: SetupDesiredProps<InteractionCallback, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.interactionCallbackResponse()?

optional customizers.interactionCallbackResponse: (bot, payload, interactionCallbackResponse) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInteractionCallbackResponse

• interactionCallbackResponse: SetupDesiredProps<InteractionCallbackResponse, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.interactionDataOptions()?

optional customizers.interactionDataOptions: (bot, payload, interactionDataOptions) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInteractionDataOption

• interactionDataOptions: InteractionDataOption

Returns

any

customizers.interactionDataResolved()?

optional customizers.interactionDataResolved: (bot, payload, interactionDataResolved) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.guildId?: bigint

• payload.resolved: DiscordInteractionDataResolved

• interactionDataResolved: InteractionDataResolved

Returns

any

customizers.interactionResource()?

optional customizers.interactionResource: (bot, payload, interactionResource) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInteractionResource

• interactionResource: SetupDesiredProps<InteractionResource, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.invite()?

optional customizers.invite: (bot, payload, invite) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInviteCreate | DiscordInviteMetadata

• invite: SetupDesiredProps<Invite, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.inviteStageInstance()?

optional customizers.inviteStageInstance: (bot, payload, inviteStageInstance) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInviteStageInstance

• inviteStageInstance: SetupDesiredProps<InviteStageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.member()?

optional customizers.member: (bot, payload, member) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMember

• member: SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.message()?

optional customizers.message: (bot, payload, message) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessage

• message: SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.messageCall()?

optional customizers.messageCall: (bot, payload, call) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageCall

• call: SetupDesiredProps<MessageCall, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.messageInteractionMetadata()?

optional customizers.messageInteractionMetadata: (bot, payload, metadata) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageInteractionMetadata

• metadata: SetupDesiredProps<MessageInteractionMetadata, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.messageSnapshot()?

optional customizers.messageSnapshot: (bot, payload, messageSnapshot) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageSnapshot

• messageSnapshot: SetupDesiredProps<MessageSnapshot, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.poll()?

optional customizers.poll: (bot, payload, poll) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordPoll

• poll: SetupDesiredProps<Poll, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.pollMedia()?

optional customizers.pollMedia: (bot, payload, pollMedia) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordPollMedia

• pollMedia: SetupDesiredProps<PollMedia, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.presence()?

optional customizers.presence: (bot, payload, presence) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordPresenceUpdate

• presence: PresenceUpdate

Returns

any

customizers.role()?

optional customizers.role: (bot, payload, role) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordRole

• role: SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.scheduledEvent()?

optional customizers.scheduledEvent: (bot, payload, scheduledEvent) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordScheduledEvent

• scheduledEvent: SetupDesiredProps<ScheduledEvent, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.scheduledEventRecurrenceRule()?

optional customizers.scheduledEventRecurrenceRule: (bot, payload, scheduledEvent) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordScheduledEventRecurrenceRule

• scheduledEvent: SetupDesiredProps<ScheduledEventRecurrenceRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.sku()?

optional customizers.sku: (bot, payload, sku) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSku

• sku: SetupDesiredProps<Sku, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.soundboardSound()?

optional customizers.soundboardSound: (bot, payload, soundboardSound) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSoundboardSound

• soundboardSound: SetupDesiredProps<SoundboardSound, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.stageInstance()?

optional customizers.stageInstance: (bot, payload, stageInstance) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordStageInstance

• stageInstance: SetupDesiredProps<StageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.sticker()?

optional customizers.sticker: (bot, payload, sticker) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSticker

• sticker: SetupDesiredProps<Sticker, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.stickerPack()?

optional customizers.stickerPack: (bot, payload, stickerPack) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordStickerPack

• stickerPack: StickerPack

Returns

any

customizers.subscription()?

optional customizers.subscription: (bot, payload, subscription) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSubscription

• subscription: SetupDesiredProps<Subscription, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.team()?

optional customizers.team: (bot, payload, team) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordTeam

• team: Team

Returns

any

customizers.template()?

optional customizers.template: (bot, payload, template) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordTemplate

• template: Template

Returns

any

customizers.threadMember()?

optional customizers.threadMember: (bot, payload, threadMember) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordThreadMember

• threadMember: ThreadMember

Returns

any

customizers.threadMemberGuildCreate()?

optional customizers.threadMemberGuildCreate: (bot, payload, threadMemberGuildCreate) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordThreadMemberGuildCreate

• threadMemberGuildCreate: ThreadMemberGuildCreate

Returns

any

customizers.user()?

optional customizers.user: (bot, payload, user) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordUser

• user: SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.voiceRegion()?

optional customizers.voiceRegion: (bot, payload, voiceRegion) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordVoiceRegion

• voiceRegion: VoiceRegion

Returns

any

customizers.voiceState()?

optional customizers.voiceState: (bot, payload, voiceState) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordVoiceState

• voiceState: SetupDesiredProps<VoiceState, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.webhook()?

optional customizers.webhook: (bot, payload, webhook) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordWebhook

• webhook: SetupDesiredProps<Webhook, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.welcomeScreen()?

optional customizers.welcomeScreen: (bot, payload, welcomeScreen) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordWelcomeScreen

• welcomeScreen: WelcomeScreen

Returns

any

customizers.widget()?

optional customizers.widget: (bot, payload, widget) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildWidget

• widget: GuildWidget

Returns

any

customizers.widgetSettings()?

optional customizers.widgetSettings: (bot, payload, widgetSettings) => any

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildWidgetSettings

• widgetSettings: GuildWidgetSettings

Returns

any

defaultReactionEmoji()?

optional defaultReactionEmoji: (bot, payload) => SetupDesiredProps<DefaultReactionEmoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordDefaultReactionEmoji

Returns

SetupDesiredProps<DefaultReactionEmoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

desiredProperties?

optional desiredProperties: object

desiredProperties.activityInstance?

optional desiredProperties.activityInstance: object

desiredProperties.activityInstance.applicationId

desiredProperties.activityInstance.applicationId: undefined | boolean

desiredProperties.activityInstance.instanceId

desiredProperties.activityInstance.instanceId: undefined | boolean

desiredProperties.activityInstance.launchId

desiredProperties.activityInstance.launchId: undefined | boolean

desiredProperties.activityInstance.location

desiredProperties.activityInstance.location: undefined | boolean

desiredProperties.activityInstance.users

desiredProperties.activityInstance.users: undefined | boolean

desiredProperties.activityLocation?

optional desiredProperties.activityLocation: object

desiredProperties.activityLocation.channelId

desiredProperties.activityLocation.channelId: undefined | boolean

desiredProperties.activityLocation.guildId

desiredProperties.activityLocation.guildId: undefined | boolean

desiredProperties.activityLocation.id

desiredProperties.activityLocation.id: undefined | boolean

desiredProperties.activityLocation.kind

desiredProperties.activityLocation.kind: undefined | boolean

desiredProperties.attachment?

optional desiredProperties.attachment: object

desiredProperties.attachment.contentType

desiredProperties.attachment.contentType: undefined | boolean

desiredProperties.attachment.description

desiredProperties.attachment.description: undefined | boolean

desiredProperties.attachment.duration_secs

desiredProperties.attachment.duration_secs: undefined | boolean

desiredProperties.attachment.ephemeral

desiredProperties.attachment.ephemeral: undefined | boolean

desiredProperties.attachment.filename

desiredProperties.attachment.filename: undefined | boolean

desiredProperties.attachment.flags

desiredProperties.attachment.flags: undefined | boolean

desiredProperties.attachment.height

desiredProperties.attachment.height: undefined | boolean

desiredProperties.attachment.id

desiredProperties.attachment.id: undefined | boolean

desiredProperties.attachment.proxyUrl

desiredProperties.attachment.proxyUrl: undefined | boolean

desiredProperties.attachment.size

desiredProperties.attachment.size: undefined | boolean

desiredProperties.attachment.title

desiredProperties.attachment.title: undefined | boolean

desiredProperties.attachment.url

desiredProperties.attachment.url: undefined | boolean

desiredProperties.attachment.waveform

desiredProperties.attachment.waveform: undefined | boolean

desiredProperties.attachment.width

desiredProperties.attachment.width: undefined | boolean

desiredProperties.avatarDecorationData?

optional desiredProperties.avatarDecorationData: object

desiredProperties.avatarDecorationData.asset

desiredProperties.avatarDecorationData.asset: undefined | boolean

desiredProperties.avatarDecorationData.skuId

desiredProperties.avatarDecorationData.skuId: undefined | boolean

desiredProperties.channel?

optional desiredProperties.channel: object

desiredProperties.channel.applicationId

desiredProperties.channel.applicationId: undefined | boolean

desiredProperties.channel.appliedTags

desiredProperties.channel.appliedTags: undefined | boolean

desiredProperties.channel.availableTags

desiredProperties.channel.availableTags: undefined | boolean

desiredProperties.channel.bitrate

desiredProperties.channel.bitrate: undefined | boolean

desiredProperties.channel.defaultAutoArchiveDuration

desiredProperties.channel.defaultAutoArchiveDuration: undefined | boolean

desiredProperties.channel.defaultForumLayout

desiredProperties.channel.defaultForumLayout: undefined | boolean

desiredProperties.channel.defaultReactionEmoji

desiredProperties.channel.defaultReactionEmoji: undefined | boolean

desiredProperties.channel.defaultSortOrder

desiredProperties.channel.defaultSortOrder: undefined | boolean

desiredProperties.channel.defaultThreadRateLimitPerUser

desiredProperties.channel.defaultThreadRateLimitPerUser: undefined | boolean

desiredProperties.channel.flags

desiredProperties.channel.flags: undefined | boolean

desiredProperties.channel.guildId

desiredProperties.channel.guildId: undefined | boolean

desiredProperties.channel.icon

desiredProperties.channel.icon: undefined | boolean

desiredProperties.channel.id

desiredProperties.channel.id: undefined | boolean

desiredProperties.channel.lastMessageId

desiredProperties.channel.lastMessageId: undefined | boolean

desiredProperties.channel.lastPinTimestamp

desiredProperties.channel.lastPinTimestamp: undefined | boolean

desiredProperties.channel.member

desiredProperties.channel.member: undefined | boolean

desiredProperties.channel.memberCount

desiredProperties.channel.memberCount: undefined | boolean

desiredProperties.channel.messageCount

desiredProperties.channel.messageCount: undefined | boolean

desiredProperties.channel.name

desiredProperties.channel.name: undefined | boolean

desiredProperties.channel.ownerId

desiredProperties.channel.ownerId: undefined | boolean

desiredProperties.channel.parentId

desiredProperties.channel.parentId: undefined | boolean

desiredProperties.channel.permissionOverwrites

desiredProperties.channel.permissionOverwrites: undefined | boolean

desiredProperties.channel.permissions

desiredProperties.channel.permissions: undefined | boolean

desiredProperties.channel.position

desiredProperties.channel.position: undefined | boolean

desiredProperties.channel.rateLimitPerUser

desiredProperties.channel.rateLimitPerUser: undefined | boolean

desiredProperties.channel.recipients

desiredProperties.channel.recipients: undefined | boolean

desiredProperties.channel.rtcRegion

desiredProperties.channel.rtcRegion: undefined | boolean

desiredProperties.channel.threadMetadata

desiredProperties.channel.threadMetadata: undefined | boolean

desiredProperties.channel.topic

desiredProperties.channel.topic: undefined | boolean

desiredProperties.channel.totalMessageSent

desiredProperties.channel.totalMessageSent: undefined | boolean

desiredProperties.channel.type

desiredProperties.channel.type: undefined | boolean

desiredProperties.channel.userLimit

desiredProperties.channel.userLimit: undefined | boolean

desiredProperties.channel.videoQualityMode

desiredProperties.channel.videoQualityMode: undefined | boolean

desiredProperties.defaultReactionEmoji?

optional desiredProperties.defaultReactionEmoji: object

desiredProperties.defaultReactionEmoji.emojiId

desiredProperties.defaultReactionEmoji.emojiId: undefined | boolean

desiredProperties.defaultReactionEmoji.emojiName

desiredProperties.defaultReactionEmoji.emojiName: undefined | boolean

desiredProperties.emoji?

optional desiredProperties.emoji: object

desiredProperties.emoji.id

desiredProperties.emoji.id: undefined | boolean

desiredProperties.emoji.name

desiredProperties.emoji.name: undefined | boolean

desiredProperties.emoji.roles

desiredProperties.emoji.roles: undefined | boolean

desiredProperties.emoji.user

desiredProperties.emoji.user: undefined | boolean

desiredProperties.entitlement?

optional desiredProperties.entitlement: object

desiredProperties.entitlement.applicationId

desiredProperties.entitlement.applicationId: undefined | boolean

desiredProperties.entitlement.consumed

desiredProperties.entitlement.consumed: undefined | boolean

desiredProperties.entitlement.deleted

desiredProperties.entitlement.deleted: undefined | boolean

desiredProperties.entitlement.endsAt

desiredProperties.entitlement.endsAt: undefined | boolean

desiredProperties.entitlement.guildId

desiredProperties.entitlement.guildId: undefined | boolean

desiredProperties.entitlement.id

desiredProperties.entitlement.id: undefined | boolean

desiredProperties.entitlement.skuId

desiredProperties.entitlement.skuId: undefined | boolean

desiredProperties.entitlement.startsAt

desiredProperties.entitlement.startsAt: undefined | boolean

desiredProperties.entitlement.type

desiredProperties.entitlement.type: undefined | boolean

desiredProperties.entitlement.userId

desiredProperties.entitlement.userId: undefined | boolean

desiredProperties.forumTag?

optional desiredProperties.forumTag: object

desiredProperties.forumTag.emojiId

desiredProperties.forumTag.emojiId: undefined | boolean

desiredProperties.forumTag.emojiName

desiredProperties.forumTag.emojiName: undefined | boolean

desiredProperties.forumTag.id

desiredProperties.forumTag.id: undefined | boolean

desiredProperties.forumTag.moderated

desiredProperties.forumTag.moderated: undefined | boolean

desiredProperties.forumTag.name

desiredProperties.forumTag.name: undefined | boolean

desiredProperties.guild?

optional desiredProperties.guild: object

desiredProperties.guild.afkChannelId

desiredProperties.guild.afkChannelId: undefined | boolean

desiredProperties.guild.afkTimeout

desiredProperties.guild.afkTimeout: undefined | boolean

desiredProperties.guild.applicationId

desiredProperties.guild.applicationId: undefined | boolean

desiredProperties.guild.approximateMemberCount

desiredProperties.guild.approximateMemberCount: undefined | boolean

desiredProperties.guild.approximatePresenceCount

desiredProperties.guild.approximatePresenceCount: undefined | boolean

desiredProperties.guild.banner

desiredProperties.guild.banner: undefined | boolean

desiredProperties.guild.channels

desiredProperties.guild.channels: undefined | boolean

desiredProperties.guild.defaultMessageNotifications

desiredProperties.guild.defaultMessageNotifications: undefined | boolean

desiredProperties.guild.description

desiredProperties.guild.description: undefined | boolean

desiredProperties.guild.discoverySplash

desiredProperties.guild.discoverySplash: undefined | boolean

desiredProperties.guild.emojis

desiredProperties.guild.emojis: undefined | boolean

desiredProperties.guild.explicitContentFilter

desiredProperties.guild.explicitContentFilter: undefined | boolean

desiredProperties.guild.icon

desiredProperties.guild.icon: undefined | boolean

desiredProperties.guild.iconHash

desiredProperties.guild.iconHash: undefined | boolean

desiredProperties.guild.id

desiredProperties.guild.id: undefined | boolean

desiredProperties.guild.joinedAt

desiredProperties.guild.joinedAt: undefined | boolean

desiredProperties.guild.large

desiredProperties.guild.large: undefined | boolean

desiredProperties.guild.maxMembers

desiredProperties.guild.maxMembers: undefined | boolean

desiredProperties.guild.maxPresences

desiredProperties.guild.maxPresences: undefined | boolean

desiredProperties.guild.maxStageVideoChannelUsers

desiredProperties.guild.maxStageVideoChannelUsers: undefined | boolean

desiredProperties.guild.maxVideoChannelUsers

desiredProperties.guild.maxVideoChannelUsers: undefined | boolean

desiredProperties.guild.memberCount

desiredProperties.guild.memberCount: undefined | boolean

desiredProperties.guild.members

desiredProperties.guild.members: undefined | boolean

desiredProperties.guild.mfaLevel

desiredProperties.guild.mfaLevel: undefined | boolean

desiredProperties.guild.name

desiredProperties.guild.name: undefined | boolean

desiredProperties.guild.nsfwLevel

desiredProperties.guild.nsfwLevel: undefined | boolean

desiredProperties.guild.owner

desiredProperties.guild.owner: undefined | boolean

desiredProperties.guild.ownerId

desiredProperties.guild.ownerId: undefined | boolean

desiredProperties.guild.permissions

desiredProperties.guild.permissions: undefined | boolean

desiredProperties.guild.preferredLocale

desiredProperties.guild.preferredLocale: undefined | boolean

desiredProperties.guild.premiumProgressBarEnabled

desiredProperties.guild.premiumProgressBarEnabled: undefined | boolean

desiredProperties.guild.premiumSubscriptionCount

desiredProperties.guild.premiumSubscriptionCount: undefined | boolean

desiredProperties.guild.premiumTier

desiredProperties.guild.premiumTier: undefined | boolean

desiredProperties.guild.presences

desiredProperties.guild.presences: undefined | boolean

desiredProperties.guild.publicUpdatesChannelId

desiredProperties.guild.publicUpdatesChannelId: undefined | boolean

desiredProperties.guild.roles

desiredProperties.guild.roles: undefined | boolean

desiredProperties.guild.rulesChannelId

desiredProperties.guild.rulesChannelId: undefined | boolean

desiredProperties.guild.safetyAlertsChannelId

desiredProperties.guild.safetyAlertsChannelId: undefined | boolean

desiredProperties.guild.shardId

desiredProperties.guild.shardId: undefined | boolean

desiredProperties.guild.splash

desiredProperties.guild.splash: undefined | boolean

desiredProperties.guild.stageInstances

desiredProperties.guild.stageInstances: undefined | boolean

desiredProperties.guild.stickers

desiredProperties.guild.stickers: undefined | boolean

desiredProperties.guild.systemChannelFlags

desiredProperties.guild.systemChannelFlags: undefined | boolean

desiredProperties.guild.systemChannelId

desiredProperties.guild.systemChannelId: undefined | boolean

desiredProperties.guild.toggles

desiredProperties.guild.toggles: undefined | boolean

desiredProperties.guild.unavailable

desiredProperties.guild.unavailable: undefined | boolean

desiredProperties.guild.vanityUrlCode

desiredProperties.guild.vanityUrlCode: undefined | boolean

desiredProperties.guild.verificationLevel

desiredProperties.guild.verificationLevel: undefined | boolean

desiredProperties.guild.voiceStates

desiredProperties.guild.voiceStates: undefined | boolean

desiredProperties.guild.welcomeScreen

desiredProperties.guild.welcomeScreen: undefined | boolean

desiredProperties.guild.widgetChannelId

desiredProperties.guild.widgetChannelId: undefined | boolean

desiredProperties.guild.widgetEnabled

desiredProperties.guild.widgetEnabled: undefined | boolean

desiredProperties.guildOnboarding?

optional desiredProperties.guildOnboarding: object

desiredProperties.guildOnboarding.defaultChannelIds

desiredProperties.guildOnboarding.defaultChannelIds: undefined | boolean

desiredProperties.guildOnboarding.enabled

desiredProperties.guildOnboarding.enabled: undefined | boolean

desiredProperties.guildOnboarding.guildId

desiredProperties.guildOnboarding.guildId: undefined | boolean

desiredProperties.guildOnboarding.mode

desiredProperties.guildOnboarding.mode: undefined | boolean

desiredProperties.guildOnboarding.prompts

desiredProperties.guildOnboarding.prompts: undefined | boolean

desiredProperties.guildOnboardingPrompt?

optional desiredProperties.guildOnboardingPrompt: object

desiredProperties.guildOnboardingPrompt.id

desiredProperties.guildOnboardingPrompt.id: undefined | boolean

desiredProperties.guildOnboardingPrompt.inOnboarding

desiredProperties.guildOnboardingPrompt.inOnboarding: undefined | boolean

desiredProperties.guildOnboardingPrompt.options

desiredProperties.guildOnboardingPrompt.options: undefined | boolean

desiredProperties.guildOnboardingPrompt.required

desiredProperties.guildOnboardingPrompt.required: undefined | boolean

desiredProperties.guildOnboardingPrompt.singleSelect

desiredProperties.guildOnboardingPrompt.singleSelect: undefined | boolean

desiredProperties.guildOnboardingPrompt.title

desiredProperties.guildOnboardingPrompt.title: undefined | boolean

desiredProperties.guildOnboardingPrompt.type

desiredProperties.guildOnboardingPrompt.type: undefined | boolean

desiredProperties.guildOnboardingPromptOption?

optional desiredProperties.guildOnboardingPromptOption: object

desiredProperties.guildOnboardingPromptOption.channelIds

desiredProperties.guildOnboardingPromptOption.channelIds: undefined | boolean

desiredProperties.guildOnboardingPromptOption.description

desiredProperties.guildOnboardingPromptOption.description: undefined | boolean

desiredProperties.guildOnboardingPromptOption.emoji

desiredProperties.guildOnboardingPromptOption.emoji: undefined | boolean

desiredProperties.guildOnboardingPromptOption.id

desiredProperties.guildOnboardingPromptOption.id: undefined | boolean

desiredProperties.guildOnboardingPromptOption.roleIds

desiredProperties.guildOnboardingPromptOption.roleIds: undefined | boolean

desiredProperties.guildOnboardingPromptOption.title

desiredProperties.guildOnboardingPromptOption.title: undefined | boolean

desiredProperties.interaction?

optional desiredProperties.interaction: object

desiredProperties.interaction.applicationId

desiredProperties.interaction.applicationId: undefined | boolean

desiredProperties.interaction.appPermissions

desiredProperties.interaction.appPermissions: undefined | boolean

desiredProperties.interaction.authorizingIntegrationOwners

desiredProperties.interaction.authorizingIntegrationOwners: undefined | boolean

desiredProperties.interaction.channel

desiredProperties.interaction.channel: undefined | boolean

desiredProperties.interaction.channelId

desiredProperties.interaction.channelId: undefined | boolean

desiredProperties.interaction.context

desiredProperties.interaction.context: undefined | boolean

desiredProperties.interaction.data

desiredProperties.interaction.data: undefined | boolean

desiredProperties.interaction.guild

desiredProperties.interaction.guild: undefined | boolean

desiredProperties.interaction.guildId

desiredProperties.interaction.guildId: undefined | boolean

desiredProperties.interaction.guildLocale

desiredProperties.interaction.guildLocale: undefined | boolean

desiredProperties.interaction.id

desiredProperties.interaction.id: undefined | boolean

desiredProperties.interaction.locale

desiredProperties.interaction.locale: undefined | boolean

desiredProperties.interaction.member

desiredProperties.interaction.member: undefined | boolean

desiredProperties.interaction.message

desiredProperties.interaction.message: undefined | boolean

desiredProperties.interaction.token

desiredProperties.interaction.token: undefined | boolean

desiredProperties.interaction.type

desiredProperties.interaction.type: undefined | boolean

desiredProperties.interaction.user

desiredProperties.interaction.user: undefined | boolean

desiredProperties.interaction.version

desiredProperties.interaction.version: undefined | boolean

desiredProperties.interactionCallback?

optional desiredProperties.interactionCallback: object

desiredProperties.interactionCallback.activityInstanceId

desiredProperties.interactionCallback.activityInstanceId: undefined | boolean

desiredProperties.interactionCallback.id

desiredProperties.interactionCallback.id: undefined | boolean

desiredProperties.interactionCallback.responseMessageEphemeral

desiredProperties.interactionCallback.responseMessageEphemeral: undefined | boolean

desiredProperties.interactionCallback.responseMessageId

desiredProperties.interactionCallback.responseMessageId: undefined | boolean

desiredProperties.interactionCallback.responseMessageLoading

desiredProperties.interactionCallback.responseMessageLoading: undefined | boolean

desiredProperties.interactionCallback.type

desiredProperties.interactionCallback.type: undefined | boolean

desiredProperties.interactionCallbackResponse?

optional desiredProperties.interactionCallbackResponse: object

desiredProperties.interactionCallbackResponse.interaction

desiredProperties.interactionCallbackResponse.interaction: undefined | boolean

desiredProperties.interactionCallbackResponse.resource

desiredProperties.interactionCallbackResponse.resource: undefined | boolean

desiredProperties.interactionResource?

optional desiredProperties.interactionResource: object

desiredProperties.interactionResource.activityInstance

desiredProperties.interactionResource.activityInstance: undefined | boolean

desiredProperties.interactionResource.message

desiredProperties.interactionResource.message: undefined | boolean

desiredProperties.interactionResource.type

desiredProperties.interactionResource.type: undefined | boolean

desiredProperties.invite?

optional desiredProperties.invite: object

desiredProperties.invite.approximateMemberCount

desiredProperties.invite.approximateMemberCount: undefined | boolean

desiredProperties.invite.approximatePresenceCount

desiredProperties.invite.approximatePresenceCount: undefined | boolean

desiredProperties.invite.channelId

desiredProperties.invite.channelId: undefined | boolean

desiredProperties.invite.code

desiredProperties.invite.code: undefined | boolean

desiredProperties.invite.createdAt

desiredProperties.invite.createdAt: undefined | boolean

desiredProperties.invite.expiresAt

desiredProperties.invite.expiresAt: undefined | boolean

desiredProperties.invite.guildId

desiredProperties.invite.guildId: undefined | boolean

desiredProperties.invite.guildScheduledEvent

desiredProperties.invite.guildScheduledEvent: undefined | boolean

desiredProperties.invite.inviter

desiredProperties.invite.inviter: undefined | boolean

desiredProperties.invite.maxAge

desiredProperties.invite.maxAge: undefined | boolean

desiredProperties.invite.maxUses

desiredProperties.invite.maxUses: undefined | boolean

desiredProperties.invite.stageInstance

desiredProperties.invite.stageInstance: undefined | boolean

desiredProperties.invite.targetApplication

desiredProperties.invite.targetApplication: undefined | boolean

desiredProperties.invite.targetType

desiredProperties.invite.targetType: undefined | boolean

desiredProperties.invite.targetUser

desiredProperties.invite.targetUser: undefined | boolean

desiredProperties.invite.temporary

desiredProperties.invite.temporary: undefined | boolean

desiredProperties.invite.type

desiredProperties.invite.type: undefined | boolean

desiredProperties.invite.uses

desiredProperties.invite.uses: undefined | boolean

desiredProperties.inviteStageInstance?

optional desiredProperties.inviteStageInstance: object

desiredProperties.inviteStageInstance.members

desiredProperties.inviteStageInstance.members: undefined | boolean

desiredProperties.inviteStageInstance.participantCount

desiredProperties.inviteStageInstance.participantCount: undefined | boolean

desiredProperties.inviteStageInstance.speakerCount

desiredProperties.inviteStageInstance.speakerCount: undefined | boolean

desiredProperties.inviteStageInstance.topic

desiredProperties.inviteStageInstance.topic: undefined | boolean

desiredProperties.member?

optional desiredProperties.member: object

desiredProperties.member.avatar

desiredProperties.member.avatar: undefined | boolean

desiredProperties.member.avatarDecorationData

desiredProperties.member.avatarDecorationData: undefined | boolean

desiredProperties.member.banner

desiredProperties.member.banner: undefined | boolean

desiredProperties.member.communicationDisabledUntil

desiredProperties.member.communicationDisabledUntil: undefined | boolean

desiredProperties.member.guildId

desiredProperties.member.guildId: undefined | boolean

desiredProperties.member.id

desiredProperties.member.id: undefined | boolean

desiredProperties.member.joinedAt

desiredProperties.member.joinedAt: undefined | boolean

desiredProperties.member.nick

desiredProperties.member.nick: undefined | boolean

desiredProperties.member.permissions

desiredProperties.member.permissions: undefined | boolean

desiredProperties.member.premiumSince

desiredProperties.member.premiumSince: undefined | boolean

desiredProperties.member.roles

desiredProperties.member.roles: undefined | boolean

desiredProperties.member.toggles

desiredProperties.member.toggles: undefined | boolean

desiredProperties.member.user

desiredProperties.member.user: undefined | boolean

desiredProperties.message?

optional desiredProperties.message: object

desiredProperties.message.activity

desiredProperties.message.activity: undefined | boolean

desiredProperties.message.application

desiredProperties.message.application: undefined | boolean

desiredProperties.message.applicationId

desiredProperties.message.applicationId: undefined | boolean

desiredProperties.message.attachments

desiredProperties.message.attachments: undefined | boolean

desiredProperties.message.author

desiredProperties.message.author: undefined | boolean

desiredProperties.message.call

desiredProperties.message.call: undefined | boolean

desiredProperties.message.channelId

desiredProperties.message.channelId: undefined | boolean

desiredProperties.message.components

desiredProperties.message.components: undefined | boolean

desiredProperties.message.content

desiredProperties.message.content: undefined | boolean

desiredProperties.message.editedTimestamp

desiredProperties.message.editedTimestamp: undefined | boolean

desiredProperties.message.embeds

desiredProperties.message.embeds: undefined | boolean

desiredProperties.message.guildId

desiredProperties.message.guildId: undefined | boolean

desiredProperties.message.id

desiredProperties.message.id: undefined | boolean

desiredProperties.message.interaction

desiredProperties.message.interaction: undefined | boolean

desiredProperties.message.interactionMetadata

desiredProperties.message.interactionMetadata: undefined | boolean

desiredProperties.message.member

desiredProperties.message.member: undefined | boolean

desiredProperties.message.mentionedChannelIds

desiredProperties.message.mentionedChannelIds: undefined | boolean

desiredProperties.message.mentionedRoleIds

desiredProperties.message.mentionedRoleIds: undefined | boolean

desiredProperties.message.mentions

desiredProperties.message.mentions: undefined | boolean

desiredProperties.message.messageReference

desiredProperties.message.messageReference: undefined | boolean

desiredProperties.message.messageSnapshots

desiredProperties.message.messageSnapshots: undefined | boolean

desiredProperties.message.nonce

desiredProperties.message.nonce: undefined | boolean

desiredProperties.message.poll

desiredProperties.message.poll: undefined | boolean

desiredProperties.message.reactions

desiredProperties.message.reactions: undefined | boolean

desiredProperties.message.referencedMessage

desiredProperties.message.referencedMessage: undefined | boolean

desiredProperties.message.stickerItems

desiredProperties.message.stickerItems: undefined | boolean

desiredProperties.message.thread

desiredProperties.message.thread: undefined | boolean

desiredProperties.message.type

desiredProperties.message.type: undefined | boolean

desiredProperties.message.webhookId

desiredProperties.message.webhookId: undefined | boolean

desiredProperties.messageCall?

optional desiredProperties.messageCall: object

desiredProperties.messageCall.endedTimestamp

desiredProperties.messageCall.endedTimestamp: undefined | boolean

desiredProperties.messageCall.participants

desiredProperties.messageCall.participants: undefined | boolean

desiredProperties.messageInteraction?

optional desiredProperties.messageInteraction: object

desiredProperties.messageInteraction.id

desiredProperties.messageInteraction.id: undefined | boolean

desiredProperties.messageInteraction.member

desiredProperties.messageInteraction.member: undefined | boolean

desiredProperties.messageInteraction.name

desiredProperties.messageInteraction.name: undefined | boolean

desiredProperties.messageInteraction.type

desiredProperties.messageInteraction.type: undefined | boolean

desiredProperties.messageInteraction.user

desiredProperties.messageInteraction.user: undefined | boolean

desiredProperties.messageInteractionMetadata?

optional desiredProperties.messageInteractionMetadata: object

desiredProperties.messageInteractionMetadata.authorizingIntegrationOwners

desiredProperties.messageInteractionMetadata.authorizingIntegrationOwners: undefined | boolean

desiredProperties.messageInteractionMetadata.id

desiredProperties.messageInteractionMetadata.id: undefined | boolean

desiredProperties.messageInteractionMetadata.interactedMessageId

desiredProperties.messageInteractionMetadata.interactedMessageId: undefined | boolean

desiredProperties.messageInteractionMetadata.originalResponseMessageId

desiredProperties.messageInteractionMetadata.originalResponseMessageId: undefined | boolean

desiredProperties.messageInteractionMetadata.targetMessageId

desiredProperties.messageInteractionMetadata.targetMessageId: undefined | boolean

desiredProperties.messageInteractionMetadata.targetUser

desiredProperties.messageInteractionMetadata.targetUser: undefined | boolean

desiredProperties.messageInteractionMetadata.triggeringInteractionMetadata

desiredProperties.messageInteractionMetadata.triggeringInteractionMetadata: undefined | boolean

desiredProperties.messageInteractionMetadata.type

desiredProperties.messageInteractionMetadata.type: undefined | boolean

desiredProperties.messageInteractionMetadata.user

desiredProperties.messageInteractionMetadata.user: undefined | boolean

desiredProperties.messageReference?

optional desiredProperties.messageReference: object

desiredProperties.messageReference.channelId

desiredProperties.messageReference.channelId: undefined | boolean

desiredProperties.messageReference.guildId

desiredProperties.messageReference.guildId: undefined | boolean

desiredProperties.messageReference.messageId

desiredProperties.messageReference.messageId: undefined | boolean

desiredProperties.messageSnapshot?

optional desiredProperties.messageSnapshot: object

desiredProperties.messageSnapshot.message

desiredProperties.messageSnapshot.message: undefined | boolean

desiredProperties.poll?

optional desiredProperties.poll: object

desiredProperties.poll.allowMultiselect

desiredProperties.poll.allowMultiselect: undefined | boolean

desiredProperties.poll.answers

desiredProperties.poll.answers: undefined | boolean

desiredProperties.poll.expiry

desiredProperties.poll.expiry: undefined | boolean

desiredProperties.poll.layoutType

desiredProperties.poll.layoutType: undefined | boolean

desiredProperties.poll.question

desiredProperties.poll.question: undefined | boolean

desiredProperties.poll.results

desiredProperties.poll.results: undefined | boolean

desiredProperties.pollAnswer?

optional desiredProperties.pollAnswer: object

desiredProperties.pollAnswer.answerId

desiredProperties.pollAnswer.answerId: undefined | boolean

desiredProperties.pollAnswer.pollMedia

desiredProperties.pollAnswer.pollMedia: undefined | boolean

desiredProperties.pollAnswerCount?

optional desiredProperties.pollAnswerCount: object

desiredProperties.pollAnswerCount.count

desiredProperties.pollAnswerCount.count: undefined | boolean

desiredProperties.pollAnswerCount.id

desiredProperties.pollAnswerCount.id: undefined | boolean

desiredProperties.pollAnswerCount.meVoted

desiredProperties.pollAnswerCount.meVoted: undefined | boolean

desiredProperties.pollMedia?

optional desiredProperties.pollMedia: object

desiredProperties.pollMedia.emoji

desiredProperties.pollMedia.emoji: undefined | boolean

desiredProperties.pollMedia.text

desiredProperties.pollMedia.text: undefined | boolean

desiredProperties.pollResult?

optional desiredProperties.pollResult: object

desiredProperties.pollResult.answerCounts

desiredProperties.pollResult.answerCounts: undefined | boolean

desiredProperties.pollResult.isFinalized

desiredProperties.pollResult.isFinalized: undefined | boolean

desiredProperties.role?

optional desiredProperties.role: object

desiredProperties.role.color

desiredProperties.role.color: undefined | boolean

desiredProperties.role.flags

desiredProperties.role.flags: undefined | boolean

desiredProperties.role.guildId

desiredProperties.role.guildId: undefined | boolean

desiredProperties.role.icon

desiredProperties.role.icon: undefined | boolean

desiredProperties.role.id

desiredProperties.role.id: undefined | boolean

desiredProperties.role.name

desiredProperties.role.name: undefined | boolean

desiredProperties.role.permissions

desiredProperties.role.permissions: undefined | boolean

desiredProperties.role.position

desiredProperties.role.position: undefined | boolean

desiredProperties.role.tags

desiredProperties.role.tags: undefined | boolean

desiredProperties.role.toggles

desiredProperties.role.toggles: undefined | boolean

desiredProperties.role.unicodeEmoji

desiredProperties.role.unicodeEmoji: undefined | boolean

desiredProperties.scheduledEvent?

optional desiredProperties.scheduledEvent: object

desiredProperties.scheduledEvent.channelId

desiredProperties.scheduledEvent.channelId: undefined | boolean

desiredProperties.scheduledEvent.creator

desiredProperties.scheduledEvent.creator: undefined | boolean

desiredProperties.scheduledEvent.creatorId

desiredProperties.scheduledEvent.creatorId: undefined | boolean

desiredProperties.scheduledEvent.description

desiredProperties.scheduledEvent.description: undefined | boolean

desiredProperties.scheduledEvent.entityId

desiredProperties.scheduledEvent.entityId: undefined | boolean

desiredProperties.scheduledEvent.entityType

desiredProperties.scheduledEvent.entityType: undefined | boolean

desiredProperties.scheduledEvent.guildId

desiredProperties.scheduledEvent.guildId: undefined | boolean

desiredProperties.scheduledEvent.id

desiredProperties.scheduledEvent.id: undefined | boolean

desiredProperties.scheduledEvent.image

desiredProperties.scheduledEvent.image: undefined | boolean

desiredProperties.scheduledEvent.location

desiredProperties.scheduledEvent.location: undefined | boolean

desiredProperties.scheduledEvent.name

desiredProperties.scheduledEvent.name: undefined | boolean

desiredProperties.scheduledEvent.privacyLevel

desiredProperties.scheduledEvent.privacyLevel: undefined | boolean

desiredProperties.scheduledEvent.recurrenceRule

desiredProperties.scheduledEvent.recurrenceRule: undefined | boolean

desiredProperties.scheduledEvent.scheduledEndTime

desiredProperties.scheduledEvent.scheduledEndTime: undefined | boolean

desiredProperties.scheduledEvent.scheduledStartTime

desiredProperties.scheduledEvent.scheduledStartTime: undefined | boolean

desiredProperties.scheduledEvent.status

desiredProperties.scheduledEvent.status: undefined | boolean

desiredProperties.scheduledEvent.userCount

desiredProperties.scheduledEvent.userCount: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule?

optional desiredProperties.scheduledEventRecurrenceRule: object

desiredProperties.scheduledEventRecurrenceRule.byMonth

desiredProperties.scheduledEventRecurrenceRule.byMonth: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byMonthDay

desiredProperties.scheduledEventRecurrenceRule.byMonthDay: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byNWeekday

desiredProperties.scheduledEventRecurrenceRule.byNWeekday: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byWeekday

desiredProperties.scheduledEventRecurrenceRule.byWeekday: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byYearDay

desiredProperties.scheduledEventRecurrenceRule.byYearDay: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.count

desiredProperties.scheduledEventRecurrenceRule.count: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.end

desiredProperties.scheduledEventRecurrenceRule.end: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.frequency

desiredProperties.scheduledEventRecurrenceRule.frequency: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.interval

desiredProperties.scheduledEventRecurrenceRule.interval: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.start

desiredProperties.scheduledEventRecurrenceRule.start: undefined | boolean

desiredProperties.sku?

optional desiredProperties.sku: object

desiredProperties.sku.applicationId

desiredProperties.sku.applicationId: undefined | boolean

desiredProperties.sku.flags

desiredProperties.sku.flags: undefined | boolean

desiredProperties.sku.id

desiredProperties.sku.id: undefined | boolean

desiredProperties.sku.name

desiredProperties.sku.name: undefined | boolean

desiredProperties.sku.slug

desiredProperties.sku.slug: undefined | boolean

desiredProperties.sku.type

desiredProperties.sku.type: undefined | boolean

desiredProperties.soundboardSound?

optional desiredProperties.soundboardSound: object

desiredProperties.soundboardSound.available

desiredProperties.soundboardSound.available: undefined | boolean

desiredProperties.soundboardSound.emojiId

desiredProperties.soundboardSound.emojiId: undefined | boolean

desiredProperties.soundboardSound.emojiName

desiredProperties.soundboardSound.emojiName: undefined | boolean

desiredProperties.soundboardSound.guildId

desiredProperties.soundboardSound.guildId: undefined | boolean

desiredProperties.soundboardSound.name

desiredProperties.soundboardSound.name: undefined | boolean

desiredProperties.soundboardSound.soundId

desiredProperties.soundboardSound.soundId: undefined | boolean

desiredProperties.soundboardSound.user

desiredProperties.soundboardSound.user: undefined | boolean

desiredProperties.soundboardSound.volume

desiredProperties.soundboardSound.volume: undefined | boolean

desiredProperties.stageInstance?

optional desiredProperties.stageInstance: object

desiredProperties.stageInstance.channelId

desiredProperties.stageInstance.channelId: undefined | boolean

desiredProperties.stageInstance.guildId

desiredProperties.stageInstance.guildId: undefined | boolean

desiredProperties.stageInstance.guildScheduledEventId

desiredProperties.stageInstance.guildScheduledEventId: undefined | boolean

desiredProperties.stageInstance.id

desiredProperties.stageInstance.id: undefined | boolean

desiredProperties.stageInstance.topic

desiredProperties.stageInstance.topic: undefined | boolean

desiredProperties.sticker?

optional desiredProperties.sticker: object

desiredProperties.sticker.available

desiredProperties.sticker.available: undefined | boolean

desiredProperties.sticker.description

desiredProperties.sticker.description: undefined | boolean

desiredProperties.sticker.formatType

desiredProperties.sticker.formatType: undefined | boolean

desiredProperties.sticker.guildId

desiredProperties.sticker.guildId: undefined | boolean

desiredProperties.sticker.id

desiredProperties.sticker.id: undefined | boolean

desiredProperties.sticker.name

desiredProperties.sticker.name: undefined | boolean

desiredProperties.sticker.packId

desiredProperties.sticker.packId: undefined | boolean

desiredProperties.sticker.sortValue

desiredProperties.sticker.sortValue: undefined | boolean

desiredProperties.sticker.tags

desiredProperties.sticker.tags: undefined | boolean

desiredProperties.sticker.type

desiredProperties.sticker.type: undefined | boolean

desiredProperties.sticker.user

desiredProperties.sticker.user: undefined | boolean

desiredProperties.subscription?

optional desiredProperties.subscription: object

desiredProperties.subscription.canceledAt

desiredProperties.subscription.canceledAt: undefined | boolean

desiredProperties.subscription.country

desiredProperties.subscription.country: undefined | boolean

desiredProperties.subscription.currentPeriodEnd

desiredProperties.subscription.currentPeriodEnd: undefined | boolean

desiredProperties.subscription.currentPeriodStart

desiredProperties.subscription.currentPeriodStart: undefined | boolean

desiredProperties.subscription.entitlementIds

desiredProperties.subscription.entitlementIds: undefined | boolean

desiredProperties.subscription.id

desiredProperties.subscription.id: undefined | boolean

desiredProperties.subscription.skuIds

desiredProperties.subscription.skuIds: undefined | boolean

desiredProperties.subscription.status

desiredProperties.subscription.status: undefined | boolean

desiredProperties.subscription.userId

desiredProperties.subscription.userId: undefined | boolean

desiredProperties.user?

optional desiredProperties.user: object

desiredProperties.user.accentColor

desiredProperties.user.accentColor: undefined | boolean

desiredProperties.user.avatar

desiredProperties.user.avatar: undefined | boolean

desiredProperties.user.avatarDecorationData

desiredProperties.user.avatarDecorationData: undefined | boolean

desiredProperties.user.banner

desiredProperties.user.banner: undefined | boolean

desiredProperties.user.discriminator

desiredProperties.user.discriminator: undefined | boolean

desiredProperties.user.email

desiredProperties.user.email: undefined | boolean

desiredProperties.user.flags

desiredProperties.user.flags: undefined | boolean

desiredProperties.user.globalName

desiredProperties.user.globalName: undefined | boolean

desiredProperties.user.id

desiredProperties.user.id: undefined | boolean

desiredProperties.user.locale

desiredProperties.user.locale: undefined | boolean

desiredProperties.user.premiumType

desiredProperties.user.premiumType: undefined | boolean

desiredProperties.user.publicFlags

desiredProperties.user.publicFlags: undefined | boolean

desiredProperties.user.toggles

desiredProperties.user.toggles: undefined | boolean

desiredProperties.user.username

desiredProperties.user.username: undefined | boolean

desiredProperties.voiceState?

optional desiredProperties.voiceState: object

desiredProperties.voiceState.channelId

desiredProperties.voiceState.channelId: undefined | boolean

desiredProperties.voiceState.guildId

desiredProperties.voiceState.guildId: undefined | boolean

desiredProperties.voiceState.requestToSpeakTimestamp

desiredProperties.voiceState.requestToSpeakTimestamp: undefined | boolean

desiredProperties.voiceState.sessionId

desiredProperties.voiceState.sessionId: undefined | boolean

desiredProperties.voiceState.toggles

desiredProperties.voiceState.toggles: undefined | boolean

desiredProperties.voiceState.userId

desiredProperties.voiceState.userId: undefined | boolean

desiredProperties.webhook?

optional desiredProperties.webhook: object

desiredProperties.webhook.applicationId

desiredProperties.webhook.applicationId: undefined | boolean

desiredProperties.webhook.avatar

desiredProperties.webhook.avatar: undefined | boolean

desiredProperties.webhook.channelId

desiredProperties.webhook.channelId: undefined | boolean

desiredProperties.webhook.guildId

desiredProperties.webhook.guildId: undefined | boolean

desiredProperties.webhook.id

desiredProperties.webhook.id: undefined | boolean

desiredProperties.webhook.name

desiredProperties.webhook.name: undefined | boolean

desiredProperties.webhook.sourceChannel

desiredProperties.webhook.sourceChannel: undefined | boolean

desiredProperties.webhook.sourceGuild

desiredProperties.webhook.sourceGuild: undefined | boolean

desiredProperties.webhook.token

desiredProperties.webhook.token: undefined | boolean

desiredProperties.webhook.type

desiredProperties.webhook.type: undefined | boolean

desiredProperties.webhook.url

desiredProperties.webhook.url: undefined | boolean

desiredProperties.webhook.user

desiredProperties.webhook.user: undefined | boolean

embed()?

optional embed: (bot, payload) => Embed

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordEmbed

Returns

Embed

emoji()?

optional emoji: (bot, payload) => SetupDesiredProps<Emoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordEmoji

Returns

SetupDesiredProps<Emoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

entitlement()?

optional entitlement: (bot, payload) => SetupDesiredProps<Entitlement, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordEntitlement

Returns

SetupDesiredProps<Entitlement, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

forumTag()?

optional forumTag: (bot, payload) => SetupDesiredProps<ForumTag, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordForumTag

Returns

SetupDesiredProps<ForumTag, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

gatewayBot()?

optional gatewayBot: (bot, payload) => GetGatewayBot

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGetGatewayBot

Returns

GetGatewayBot

guild()?

optional guild: (bot, payload) => SetupDesiredProps<Guild, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.guild: DiscordGuild

• payload.shardId: number

Returns

SetupDesiredProps<Guild, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

guildOnboarding()?

optional guildOnboarding: (bot, payload) => SetupDesiredProps<GuildOnboarding, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildOnboarding

Returns

SetupDesiredProps<GuildOnboarding, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

guildOnboardingPrompt()?

optional guildOnboardingPrompt: (bot, payload) => SetupDesiredProps<GuildOnboardingPrompt, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildOnboardingPrompt

Returns

SetupDesiredProps<GuildOnboardingPrompt, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

guildOnboardingPromptOption()?

optional guildOnboardingPromptOption: (bot, payload) => GuildOnboardingPromptOption

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildOnboardingPromptOption

Returns

GuildOnboardingPromptOption

integration()?

optional integration: (bot, payload) => Integration

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordIntegrationCreateUpdate

Returns

Integration

interaction()?

optional interaction: (bot, payload) => SetupDesiredProps<Interaction, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.interaction: DiscordInteraction

• payload.shardId: number

Returns

SetupDesiredProps<Interaction, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

interactionCallback()?

optional interactionCallback: (bot, payload) => SetupDesiredProps<InteractionCallback, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInteractionCallback

Returns

SetupDesiredProps<InteractionCallback, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

interactionCallbackResponse()?

optional interactionCallbackResponse: (bot, payload) => SetupDesiredProps<InteractionCallbackResponse, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.interactionCallbackResponse: DiscordInteractionCallbackResponse

• payload.shardId: number

Returns

SetupDesiredProps<InteractionCallbackResponse, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

interactionDataOptions()?

optional interactionDataOptions: (bot, payload) => InteractionDataOption

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInteractionDataOption

Returns

InteractionDataOption

interactionDataResolved()?

optional interactionDataResolved: (bot, payload) => InteractionDataResolved

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.guildId?: bigint

• payload.resolved: DiscordInteractionDataResolved

• payload.shardId: number

Returns

InteractionDataResolved

interactionResource()?

optional interactionResource: (bot, payload) => SetupDesiredProps<InteractionResource, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.interactionResource: DiscordInteractionResource

• payload.shardId: number

Returns

SetupDesiredProps<InteractionResource, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

invite()?

optional invite: (bot, payload) => SetupDesiredProps<Invite, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.invite: DiscordInviteCreate | DiscordInviteMetadata

• payload.shardId: number

Returns

SetupDesiredProps<Invite, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

inviteStageInstance()?

optional inviteStageInstance: (bot, payload) => SetupDesiredProps<InviteStageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordInviteStageInstance & object

Returns

SetupDesiredProps<InviteStageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

member()?

optional member: (bot, payload, guildId, userId) => SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMember

• guildId: BigString

• userId: BigString

Returns

SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

message()?

optional message: (bot, payload) => SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.message: DiscordMessage

• payload.shardId: number

Returns

SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

messageCall()?

optional messageCall: (bot, payload) => SetupDesiredProps<MessageCall, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageCall

Returns

SetupDesiredProps<MessageCall, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

messageInteractionMetadata()?

optional messageInteractionMetadata: (bot, payload) => SetupDesiredProps<MessageInteractionMetadata, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordMessageInteractionMetadata

Returns

SetupDesiredProps<MessageInteractionMetadata, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

messageSnapshot()?

optional messageSnapshot: (bot, payload) => SetupDesiredProps<MessageSnapshot, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.messageSnapshot: DiscordMessageSnapshot

• payload.shardId: number

Returns

SetupDesiredProps<MessageSnapshot, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

poll()?

optional poll: (bot, payload) => SetupDesiredProps<Poll, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordPoll

Returns

SetupDesiredProps<Poll, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

pollMedia()?

optional pollMedia: (bot, payload) => SetupDesiredProps<PollMedia, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordPollMedia

Returns

SetupDesiredProps<PollMedia, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

presence()?

optional presence: (bot, payload) => PresenceUpdate

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordPresenceUpdate

Returns

PresenceUpdate

reverse?

optional reverse: object

reverse.activity()?

optional reverse.activity: (bot, payload) => DiscordActivity

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: Activity

Returns

DiscordActivity

reverse.allowedMentions()?

optional reverse.allowedMentions: (bot, payload) => DiscordAllowedMentions

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: AllowedMentions

Returns

DiscordAllowedMentions

reverse.application()?

optional reverse.application: (bot, payload) => DiscordApplication

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: Application

Returns

DiscordApplication

reverse.applicationCommand()?

optional reverse.applicationCommand: (bot, payload) => DiscordApplicationCommand

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: ApplicationCommand

Returns

DiscordApplicationCommand

reverse.applicationCommandOption()?

optional reverse.applicationCommandOption: (bot, payload) => DiscordApplicationCommandOption

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: ApplicationCommandOption

Returns

DiscordApplicationCommandOption

reverse.applicationCommandOptionChoice()?

optional reverse.applicationCommandOptionChoice: (bot, payload) => DiscordApplicationCommandOptionChoice

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: ApplicationCommandOptionChoice

Returns

DiscordApplicationCommandOptionChoice

reverse.attachment()?

optional reverse.attachment: (bot, payload) => DiscordAttachment

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

DiscordAttachment

reverse.component()?

optional reverse.component: (bot, payload) => DiscordMessageComponent

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: Component

Returns

DiscordMessageComponent

reverse.createApplicationCommand()?

optional reverse.createApplicationCommand: (bot, payload) => DiscordCreateApplicationCommand

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: CreateApplicationCommand

Returns

DiscordCreateApplicationCommand

reverse.embed()?

optional reverse.embed: (bot, payload) => DiscordEmbed

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: Embed

Returns

DiscordEmbed

reverse.member()?

optional reverse.member: (bot, payload) => DiscordMember

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

DiscordMember

reverse.snowflake()?

optional reverse.snowflake: (snowflake) => string

Parameters

• snowflake: BigString

Returns

string

reverse.team()?

optional reverse.team: (bot, payload) => DiscordTeam

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: Team

Returns

DiscordTeam

reverse.user()?

optional reverse.user: (bot, payload) => DiscordUser

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

DiscordUser

role()?

optional role: (bot, payload) => SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.guildId: BigString

• payload.role: DiscordRole

Returns

SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

scheduledEvent()?

optional scheduledEvent: (bot, payload) => SetupDesiredProps<ScheduledEvent, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordScheduledEvent

Returns

SetupDesiredProps<ScheduledEvent, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

scheduledEventRecurrenceRule()?

optional scheduledEventRecurrenceRule: (bot, payload) => SetupDesiredProps<ScheduledEventRecurrenceRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordScheduledEventRecurrenceRule

Returns

SetupDesiredProps<ScheduledEventRecurrenceRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

sku()?

optional sku: (bot, payload) => SetupDesiredProps<Sku, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSku

Returns

SetupDesiredProps<Sku, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

snowflake()?

optional snowflake: (snowflake) => bigint

Parameters

• snowflake: BigString

Returns

bigint

soundboardSound()?

optional soundboardSound: (bot, payload) => SetupDesiredProps<SoundboardSound, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSoundboardSound

Returns

SetupDesiredProps<SoundboardSound, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

stageInstance()?

optional stageInstance: (bot, payload) => SetupDesiredProps<StageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordStageInstance

Returns

SetupDesiredProps<StageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

sticker()?

optional sticker: (bot, payload) => SetupDesiredProps<Sticker, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSticker

Returns

SetupDesiredProps<Sticker, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

stickerPack()?

optional stickerPack: (bot, payload) => StickerPack

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordStickerPack

Returns

StickerPack

subscription()?

optional subscription: (bot, payload) => SetupDesiredProps<Subscription, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordSubscription

Returns

SetupDesiredProps<Subscription, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

team()?

optional team: (bot, payload) => Team

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordTeam

Returns

Team

template()?

optional template: (bot, payload) => Template

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordTemplate

Returns

Template

threadMember()?

optional threadMember: (bot, payload) => ThreadMember

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordThreadMember

Returns

ThreadMember

threadMemberGuildCreate()?

optional threadMemberGuildCreate: (bot, payload) => ThreadMemberGuildCreate

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordThreadMemberGuildCreate

Returns

ThreadMemberGuildCreate

user()?

optional user: (bot, payload) => SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordUser

Returns

SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

voiceRegion()?

optional voiceRegion: (bot, payload) => VoiceRegion

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordVoiceRegion

Returns

VoiceRegion

voiceState()?

optional voiceState: (bot, payload) => SetupDesiredProps<VoiceState, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload

• payload.guildId: BigString

• payload.voiceState: DiscordVoiceState

Returns

SetupDesiredProps<VoiceState, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

webhook()?

optional webhook: (bot, payload) => SetupDesiredProps<Webhook, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordWebhook

Returns

SetupDesiredProps<Webhook, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

welcomeScreen()?

optional welcomeScreen: (bot, payload) => WelcomeScreen

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordWelcomeScreen

Returns

WelcomeScreen

optional widget: (bot, payload) => GuildWidget

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildWidget

Returns

GuildWidget

widgetSettings()?

optional widgetSettings: (bot, payload) => GuildWidgetSettings

Parameters

• bot: Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

• payload: DiscordGuildWidgetSettings

Returns

GuildWidgetSettings

Defined in

packages/bot/src/bot.ts:116

Interface: CreateBotOptions<TProps, TBehavior>

Type Parameters​

Properties​

applicationId?​

Defined in​

desiredProperties?​

Default​

Defined in​

desiredPropertiesBehavior?​

Default​

Defined in​

events?​

Defined in​

gateway?​

Defined in​

handlers?​

Defined in​

intents?​

Defined in​

loggerFactory()?​

Parameters​

Returns​

debug()​

Parameters​

Returns​

error()​

Parameters​

Returns​

fatal()​

Parameters​

Returns​

info()​

Parameters​

Returns​

log()​

Parameters​

Returns​

setDepth()​

Parameters​

Returns​

setLevel()​

Parameters​

Returns​

warn()​

Parameters​

Returns​

Remarks​

Defined in​

rest?​

Defined in​

token​

Defined in​

transformers?​

activity()?​

Parameters​

Returns​

activityInstance()?​

Parameters​

Returns​

activityLocation()?​

Parameters​

Returns​

application()?​

Parameters​

Returns​

applicationCommand()?​

Parameters​

Returns​

applicationCommandOption()?​

Parameters​

Returns​

applicationCommandOptionChoice()?​

Parameters​

Returns​

applicationCommandPermission()?​

Parameters​

Returns​

attachment()?​

Parameters​

Returns​

Type Parameters

Properties

applicationId?

Defined in

desiredProperties?

Default

Defined in

desiredPropertiesBehavior?

Default

Defined in

events?

Defined in

gateway?

Defined in

handlers?

Defined in

intents?

Defined in

loggerFactory()?

Parameters

Returns

debug()

Parameters

Returns

error()

Parameters

Returns

fatal()

Parameters

Returns

info()

Parameters

Returns

log()

Parameters

Returns

setDepth()

Parameters

Returns

setLevel()

Parameters

Returns

warn()

Parameters

Returns

Remarks

Defined in

rest?

Defined in

token

Defined in

transformers?

activity()?

Parameters

Returns

activityInstance()?

Parameters

Returns

activityLocation()?

Parameters

Returns

application()?

Parameters

Returns

applicationCommand()?

Parameters

Returns

applicationCommandOption()?

Parameters

Returns

applicationCommandOptionChoice()?

Parameters

Returns

applicationCommandPermission()?

Parameters

Returns

attachment()?

Parameters

Returns

auditLogEntry()?