CreateBotOptions

Documentation

---

Documentation / @discordeno/bot / CreateBotOptions

Interface: CreateBotOptions<TProps, TBehavior>

Defined in: bot.ts:108

Type Parameters

TProps

TProps extends RecursivePartial<TransformersDesiredProperties>

TBehavior

TBehavior extends DesiredPropertiesBehavior

Properties

applicationId?

optional applicationId?: BigString

Defined in: bot.ts:112

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

---

desiredProperties

desiredProperties: TProps

Defined in: bot.ts:128

Set the desired properties for the bot

---

desiredPropertiesBehavior?

optional desiredPropertiesBehavior?: TBehavior

Defined in: bot.ts:134

Set the desired properties behavior for undesired properties

Default

DesiredPropertiesBehavior.RemoveKey

---

events?

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

Defined in: bot.ts:120

The event handlers.

---

gateway?

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

Defined in: bot.ts:118

Any options you wish to provide to the gateway manager.

---

handlers?

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

Defined in: bot.ts:124

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

---

intents?

optional intents?: GatewayIntents

Defined in: bot.ts:114

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

---

loggerFactory?

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

Defined in: bot.ts:143

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

Parameters

name

"REST" | "GATEWAY" | "BOT"

Returns

Pick<typeof logger, "debug" | "info" | "warn" | "error" | "fatal">

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

---

rest?

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

Defined in: bot.ts:116

Any options you wish to provide to the rest manager.

---

token

token: string

Defined in: bot.ts:110

The bot's token.

---

transformers?

optional transformers?: object

Defined in: bot.ts:122

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

activity?

optional activity?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivity, Activity, { }>

activityAssets?

optional activityAssets?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityAssets, ActivityAssets, { }>

activityEmoji?

optional activityEmoji?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityEmoji, ActivityEmoji, { }>

activityInstance?

optional activityInstance?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityInstance, ActivityInstance, { }>

activityLocation?

optional activityLocation?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityLocation, ActivityLocation, { }>

application?

optional application?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplication, Application, { shardId?: number; }>

applicationCommand?

optional applicationCommand?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommand, ApplicationCommand, { }>

applicationCommandOption?

optional applicationCommandOption?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommandOption, ApplicationCommandOption, { }>

applicationCommandOptionChoice?

optional applicationCommandOptionChoice?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommandOptionChoice, ApplicationCommandOptionChoice, { }>

applicationCommandPermissions?

optional applicationCommandPermissions?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommandPermissions, ApplicationCommandPermissions, { }>

attachment?

optional attachment?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAttachment, Attachment, { }>

auditLogEntry?

optional auditLogEntry?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAuditLogEntry, AuditLogEntry, { }>

autoModerationAction?

optional autoModerationAction?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationAction, AutoModerationAction, { }>

autoModerationActionExecution?

optional autoModerationActionExecution?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationActionExecution, AutoModerationActionExecution, { }>

autoModerationActionMetadata?

optional autoModerationActionMetadata?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationActionMetadata, AutoModerationActionMetadata, { }>

autoModerationRule?

optional autoModerationRule?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationRule, AutoModerationRule, { }>

autoModerationRuleTriggerMetadata?

optional autoModerationRuleTriggerMetadata?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationRuleTriggerMetadata, AutoModerationRuleTriggerMetadata, { }>

avatarDecorationData?

optional avatarDecorationData?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAvatarDecorationData, AvatarDecorationData, { }>

channel?

optional channel?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordChannel, Channel, { guildId?: BigString; }>

channelInfo?

optional channelInfo?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordChannelInfo, ChannelInfo, { }>

channelInfoData?

optional channelInfoData?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordChannelInfoData, ChannelInfoData, { }>

collectibles?

optional collectibles?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordCollectibles, Collectibles, { }>

component?

optional component?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse, Component, { }>

customizers?

optional customizers?: object

customizers.activity?

optional activity?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivity, Activity, BigStringsToBigints<{ }>>

customizers.activityAssets?

optional activityAssets?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityAssets, ActivityAssets, BigStringsToBigints<{ }>>

customizers.activityEmoji?

optional activityEmoji?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityEmoji, ActivityEmoji, BigStringsToBigints<{ }>>

customizers.activityInstance?

optional activityInstance?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityInstance, ActivityInstance, BigStringsToBigints<{ }>>

customizers.activityLocation?

optional activityLocation?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordActivityLocation, ActivityLocation, BigStringsToBigints<{ }>>

customizers.application?

optional application?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplication, Application, BigStringsToBigints<{ shardId?: number; }>>

customizers.applicationCommand?

optional applicationCommand?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommand, ApplicationCommand, BigStringsToBigints<{ }>>

customizers.applicationCommandOption?

optional applicationCommandOption?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommandOption, ApplicationCommandOption, BigStringsToBigints<{ }>>

customizers.applicationCommandOptionChoice?

optional applicationCommandOptionChoice?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommandOptionChoice, ApplicationCommandOptionChoice, BigStringsToBigints<{ }>>

customizers.applicationCommandPermissions?

optional applicationCommandPermissions?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordApplicationCommandPermissions, ApplicationCommandPermissions, BigStringsToBigints<{ }>>

customizers.attachment?

optional attachment?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAttachment, Attachment, BigStringsToBigints<{ }>>

customizers.auditLogEntry?

optional auditLogEntry?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAuditLogEntry, AuditLogEntry, BigStringsToBigints<{ }>>

customizers.autoModerationAction?

optional autoModerationAction?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationAction, AutoModerationAction, BigStringsToBigints<{ }>>

customizers.autoModerationActionExecution?

optional autoModerationActionExecution?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationActionExecution, AutoModerationActionExecution, BigStringsToBigints<{ }>>

customizers.autoModerationActionMetadata?

optional autoModerationActionMetadata?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationActionMetadata, AutoModerationActionMetadata, BigStringsToBigints<{ }>>

customizers.autoModerationRule?

optional autoModerationRule?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationRule, AutoModerationRule, BigStringsToBigints<{ }>>

customizers.autoModerationRuleTriggerMetadata?

optional autoModerationRuleTriggerMetadata?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationRuleTriggerMetadata, AutoModerationRuleTriggerMetadata, BigStringsToBigints<{ }>>

customizers.avatarDecorationData?

optional avatarDecorationData?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAvatarDecorationData, AvatarDecorationData, BigStringsToBigints<{ }>>

customizers.channel?

optional channel?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordChannel, Channel, BigStringsToBigints<{ guildId?: BigString; }>>

customizers.channelInfo?

optional channelInfo?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordChannelInfo, ChannelInfo, BigStringsToBigints<{ }>>

customizers.channelInfoData?

optional channelInfoData?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordChannelInfoData, ChannelInfoData, BigStringsToBigints<{ }>>

customizers.collectibles?

optional collectibles?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordCollectibles, Collectibles, BigStringsToBigints<{ }>>

customizers.component?

optional component?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse, Component, BigStringsToBigints<{ }>>

customizers.defaultReactionEmoji?

optional defaultReactionEmoji?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordDefaultReactionEmoji, DefaultReactionEmoji, BigStringsToBigints<{ }>>

customizers.embed?

optional embed?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbed, Embed, BigStringsToBigints<{ }>>

customizers.embedAuthor?

optional embedAuthor?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedAuthor, EmbedAuthor, BigStringsToBigints<{ }>>

customizers.embedFooter?

optional embedFooter?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedFooter, EmbedFooter, BigStringsToBigints<{ }>>

customizers.embedImage?

optional embedImage?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedImage, EmbedImage, BigStringsToBigints<{ }>>

customizers.embedVideo?

optional embedVideo?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedVideo, EmbedVideo, BigStringsToBigints<{ }>>

customizers.emoji?

optional emoji?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmoji, Emoji, BigStringsToBigints<{ }>>

customizers.entitlement?

optional entitlement?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEntitlement, Entitlement, BigStringsToBigints<{ }>>

customizers.forumTag?

optional forumTag?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordForumTag, ForumTag, BigStringsToBigints<{ }>>

customizers.gatewayBot?

optional gatewayBot?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGetGatewayBot, GetGatewayBot, BigStringsToBigints<{ }>>

customizers.guild?

optional guild?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuild, Guild, BigStringsToBigints<{ shardId?: number; }>>

customizers.guildApplicationCommandPermissions?

optional guildApplicationCommandPermissions?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildApplicationCommandPermissions, GuildApplicationCommandPermissions, BigStringsToBigints<{ }>>

customizers.guildOnboarding?

optional guildOnboarding?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildOnboarding, GuildOnboarding, BigStringsToBigints<{ }>>

customizers.guildOnboardingPrompt?

optional guildOnboardingPrompt?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildOnboardingPrompt, GuildOnboardingPrompt, BigStringsToBigints<{ }>>

customizers.guildOnboardingPromptOption?

optional guildOnboardingPromptOption?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildOnboardingPromptOption, GuildOnboardingPromptOption, BigStringsToBigints<{ }>>

customizers.guildWidget?

optional guildWidget?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildWidget, GuildWidget, BigStringsToBigints<{ }>>

customizers.guildWidgetSettings?

optional guildWidgetSettings?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildWidgetSettings, GuildWidgetSettings, BigStringsToBigints<{ }>>

customizers.incidentsData?

optional incidentsData?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIncidentsData, IncidentsData, BigStringsToBigints<{ }>>

customizers.integration?

optional integration?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIntegrationCreateUpdate, Integration, BigStringsToBigints<{ }>>

customizers.integrationAccount?

optional integrationAccount?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIntegrationAccount, IntegrationAccount, BigStringsToBigints<{ }>>

customizers.integrationApplication?

optional integrationApplication?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIntegrationApplication, IntegrationApplication, BigStringsToBigints<{ }>>

customizers.interaction?

optional interaction?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteraction, Interaction, BigStringsToBigints<{ shardId?: number; }>>

customizers.interactionCallback?

optional interactionCallback?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionCallback, InteractionCallback, BigStringsToBigints<{ }>>

customizers.interactionCallbackResponse?

optional interactionCallbackResponse?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionCallbackResponse, InteractionCallbackResponse, BigStringsToBigints<{ shardId?: number; }>>

customizers.interactionDataOption?

optional interactionDataOption?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionDataOption, InteractionDataOption, BigStringsToBigints<{ }>>

customizers.interactionDataResolved?

optional interactionDataResolved?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionDataResolved, InteractionDataResolved, BigStringsToBigints<{ guildId?: BigString; shardId?: number; }>>

customizers.interactionResource?

optional interactionResource?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionResource, InteractionResource, BigStringsToBigints<{ shardId?: number; }>>

customizers.invite?

optional invite?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInviteMetadata, Invite, BigStringsToBigints<{ shardId?: number; }>>

customizers.inviteStageInstance?

optional inviteStageInstance?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInviteStageInstance, InviteStageInstance, BigStringsToBigints<{ guildId?: BigString; }>>

customizers.lobby?

optional lobby?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobby, Lobby, BigStringsToBigints<{ }>>

customizers.lobbyInvite?

optional lobbyInvite?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyInvite, LobbyInvite, BigStringsToBigints<{ }>>

customizers.lobbyMember?

optional lobbyMember?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyMember, LobbyMember, BigStringsToBigints<{ }>>

customizers.lobbyMessage?

optional lobbyMessage?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyMessage, LobbyMessage, BigStringsToBigints<{ }>>

customizers.lobbyMessageLobbyMember?

optional lobbyMessageLobbyMember?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyMessageLobbyMember, LobbyMessageLobbyMember, BigStringsToBigints<{ }>>

customizers.mediaGalleryItem?

optional mediaGalleryItem?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMediaGalleryItem, MediaGalleryItem, BigStringsToBigints<{ }>>

customizers.member?

optional member?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMember, Member, BigStringsToBigints<{ guildId?: BigString; userId?: BigString; }>>

customizers.message?

optional message?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessage, Message, BigStringsToBigints<{ shardId?: number; }>>

customizers.messageCall?

optional messageCall?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageCall, MessageCall, BigStringsToBigints<{ }>>

customizers.messageInteractionMetadata?

optional messageInteractionMetadata?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageInteractionMetadata, MessageInteractionMetadata, BigStringsToBigints<{ }>>

customizers.messagePin?

optional messagePin?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessagePin, MessagePin, BigStringsToBigints<{ shardId?: number; }>>

customizers.messageSnapshot?

optional messageSnapshot?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageSnapshot, MessageSnapshot, BigStringsToBigints<{ shardId?: number; }>>

customizers.nameplate?

optional nameplate?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordNameplate, Nameplate, BigStringsToBigints<{ }>>

customizers.optionalAuditEntryInfo?

optional optionalAuditEntryInfo?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordOptionalAuditEntryInfo, OptionalAuditEntryInfo, BigStringsToBigints<{ }>>

customizers.poll?

optional poll?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordPoll, Poll, BigStringsToBigints<{ }>>

customizers.pollMedia?

optional pollMedia?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordPollMedia, PollMedia, BigStringsToBigints<{ }>>

customizers.presence?

optional presence?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordPresenceUpdate, PresenceUpdate, BigStringsToBigints<{ }>>

customizers.role?

optional role?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordRole, Role, BigStringsToBigints<{ guildId?: BigString; }>>

customizers.roleColors?

optional roleColors?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordRoleColors, RoleColors, BigStringsToBigints<{ }>>

customizers.scheduledEvent?

optional scheduledEvent?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordScheduledEvent, ScheduledEvent, BigStringsToBigints<{ }>>

customizers.scheduledEventRecurrenceRule?

optional scheduledEventRecurrenceRule?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordScheduledEventRecurrenceRule, ScheduledEventRecurrenceRule, BigStringsToBigints<{ }>>

customizers.sessionStartLimit?

optional sessionStartLimit?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSessionStartLimit, SessionStartLimit, BigStringsToBigints<{ }>>

customizers.sharedClientTheme?

optional sharedClientTheme?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSharedClientTheme, SharedClientTheme, BigStringsToBigints<{ }>>

customizers.sku?

optional sku?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSku, Sku, BigStringsToBigints<{ }>>

customizers.soundboardSound?

optional soundboardSound?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSoundboardSound, SoundboardSound, BigStringsToBigints<{ }>>

customizers.stageInstance?

optional stageInstance?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordStageInstance, StageInstance, BigStringsToBigints<{ }>>

customizers.sticker?

optional sticker?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSticker, Sticker, BigStringsToBigints<{ }>>

customizers.stickerPack?

optional stickerPack?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordStickerPack, StickerPack, BigStringsToBigints<{ }>>

customizers.subscription?

optional subscription?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSubscription, Subscription, BigStringsToBigints<{ }>>

customizers.team?

optional team?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordTeam, Team, BigStringsToBigints<{ }>>

customizers.teamMember?

optional teamMember?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordTeamMember, TeamMember, BigStringsToBigints<{ }>>

customizers.template?

optional template?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordTemplate, Template, BigStringsToBigints<{ }>>

customizers.threadMember?

optional threadMember?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordThreadMember, ThreadMember, BigStringsToBigints<ThreadMemberTransformerExtra>>

customizers.threadMemberGuildCreate?

optional threadMemberGuildCreate?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordThreadMemberGuildCreate, ThreadMemberGuildCreate, BigStringsToBigints<{ }>>

customizers.unfurledMediaItem?

optional unfurledMediaItem?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordUnfurledMediaItem, UnfurledMediaItem, BigStringsToBigints<{ }>>

customizers.user?

optional user?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordUser, User, BigStringsToBigints<{ }>>

customizers.userPrimaryGuild?

optional userPrimaryGuild?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordUserPrimaryGuild, UserPrimaryGuild, BigStringsToBigints<{ }>>

customizers.voiceRegion?

optional voiceRegion?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordVoiceRegion, VoiceRegion, BigStringsToBigints<{ }>>

customizers.voiceState?

optional voiceState?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordVoiceState, VoiceState, BigStringsToBigints<{ guildId?: BigString; }>>

customizers.webhook?

optional webhook?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordWebhook, Webhook, BigStringsToBigints<{ }>>

customizers.welcomeScreen?

optional welcomeScreen?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordWelcomeScreen, WelcomeScreen, BigStringsToBigints<{ }>>

customizers.welcomeScreenChannel?

optional welcomeScreenChannel?: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordWelcomeScreenChannel, WelcomeScreenChannel, BigStringsToBigints<{ }>>

defaultReactionEmoji?

optional defaultReactionEmoji?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordDefaultReactionEmoji, DefaultReactionEmoji, { }>

embed?

optional embed?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbed, Embed, { }>

embedAuthor?

optional embedAuthor?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedAuthor, EmbedAuthor, { }>

embedFooter?

optional embedFooter?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedFooter, EmbedFooter, { }>

embedImage?

optional embedImage?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedImage, EmbedImage, { }>

embedVideo?

optional embedVideo?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmbedVideo, EmbedVideo, { }>

emoji?

optional emoji?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEmoji, Emoji, { }>

entitlement?

optional entitlement?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordEntitlement, Entitlement, { }>

forumTag?

optional forumTag?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordForumTag, ForumTag, { }>

gatewayBot?

optional gatewayBot?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGetGatewayBot, GetGatewayBot, { }>

guild?

optional guild?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuild, Guild, { shardId?: number; }>

guildApplicationCommandPermissions?

optional guildApplicationCommandPermissions?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildApplicationCommandPermissions, GuildApplicationCommandPermissions, { }>

guildOnboarding?

optional guildOnboarding?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildOnboarding, GuildOnboarding, { }>

guildOnboardingPrompt?

optional guildOnboardingPrompt?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildOnboardingPrompt, GuildOnboardingPrompt, { }>

guildOnboardingPromptOption?

optional guildOnboardingPromptOption?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildOnboardingPromptOption, GuildOnboardingPromptOption, { }>

guildWidget?

optional guildWidget?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildWidget, GuildWidget, { }>

guildWidgetSettings?

optional guildWidgetSettings?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildWidgetSettings, GuildWidgetSettings, { }>

incidentsData?

optional incidentsData?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIncidentsData, IncidentsData, { }>

integration?

optional integration?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIntegrationCreateUpdate, Integration, { }>

integrationAccount?

optional integrationAccount?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIntegrationAccount, IntegrationAccount, { }>

integrationApplication?

optional integrationApplication?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordIntegrationApplication, IntegrationApplication, { }>

interaction?

optional interaction?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteraction, Interaction, { shardId?: number; }>

interactionCallback?

optional interactionCallback?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionCallback, InteractionCallback, { }>

interactionCallbackResponse?

optional interactionCallbackResponse?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionCallbackResponse, InteractionCallbackResponse, { shardId?: number; }>

interactionDataOption?

optional interactionDataOption?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionDataOption, InteractionDataOption, { }>

interactionDataResolved?

optional interactionDataResolved?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionDataResolved, InteractionDataResolved, { guildId?: BigString; shardId?: number; }>

interactionResource?

optional interactionResource?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionResource, InteractionResource, { shardId?: number; }>

invite?

optional invite?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInviteMetadata, Invite, { shardId?: number; }>

inviteStageInstance?

optional inviteStageInstance?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInviteStageInstance, InviteStageInstance, { guildId?: BigString; }>

lobby?

optional lobby?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobby, Lobby, { }>

lobbyInvite?

optional lobbyInvite?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyInvite, LobbyInvite, { }>

lobbyMember?

optional lobbyMember?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyMember, LobbyMember, { }>

lobbyMessage?

optional lobbyMessage?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyMessage, LobbyMessage, { }>

lobbyMessageLobbyMember?

optional lobbyMessageLobbyMember?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordLobbyMessageLobbyMember, LobbyMessageLobbyMember, { }>

mediaGalleryItem?

optional mediaGalleryItem?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMediaGalleryItem, MediaGalleryItem, { }>

member?

optional member?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMember, Member, { guildId?: BigString; userId?: BigString; }>

message?

optional message?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessage, Message, { shardId?: number; }>

messageCall?

optional messageCall?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageCall, MessageCall, { }>

messageInteractionMetadata?

optional messageInteractionMetadata?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageInteractionMetadata, MessageInteractionMetadata, { }>

messagePin?

optional messagePin?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessagePin, MessagePin, { shardId?: number; }>

messageSnapshot?

optional messageSnapshot?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordMessageSnapshot, MessageSnapshot, { shardId?: number; }>

nameplate?

optional nameplate?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordNameplate, Nameplate, { }>

optionalAuditEntryInfo?

optional optionalAuditEntryInfo?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordOptionalAuditEntryInfo, OptionalAuditEntryInfo, { }>

poll?

optional poll?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordPoll, Poll, { }>

pollMedia?

optional pollMedia?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordPollMedia, PollMedia, { }>

presence?

optional presence?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordPresenceUpdate, PresenceUpdate, { }>

reverse?

optional reverse?: object

reverse.activity?

optional activity?: (bot, payload) => DiscordActivity

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Activity

Returns

DiscordActivity

reverse.activityAssets?

optional activityAssets?: (bot, payload) => DiscordActivityAssets

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ActivityAssets

Returns

DiscordActivityAssets

reverse.allowedMentions?

optional allowedMentions?: (bot, payload) => DiscordAllowedMentions

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

AllowedMentions

Returns

DiscordAllowedMentions

reverse.application?

optional application?: (bot, payload) => DiscordApplication

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Application

Returns

DiscordApplication

reverse.applicationCommand?

optional applicationCommand?: (bot, payload) => DiscordApplicationCommand

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ApplicationCommand

Returns

DiscordApplicationCommand

reverse.applicationCommandOption?

optional applicationCommandOption?: (bot, payload) => DiscordApplicationCommandOption

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ApplicationCommandOption

Returns

DiscordApplicationCommandOption

reverse.applicationCommandOptionChoice?

optional applicationCommandOptionChoice?: (bot, payload) => DiscordApplicationCommandOptionChoice

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ApplicationCommandOptionChoice

Returns

DiscordApplicationCommandOptionChoice

reverse.attachment?

optional attachment?: (bot, payload) => DiscordAttachment

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<Attachment, TProps, TBehavior>

Returns

DiscordAttachment

reverse.collectibles?

optional collectibles?: (bot, payload) => DiscordCollectibles

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<Collectibles, TProps, TBehavior>

Returns

DiscordCollectibles

reverse.component?

optional component?: (bot, payload) => DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Component

Returns

DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse

reverse.embed?

optional embed?: (bot, payload) => DiscordEmbed

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Embed

Returns

DiscordEmbed

reverse.mediaGalleryItem?

optional mediaGalleryItem?: (bot, payload) => DiscordMediaGalleryItem

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

MediaGalleryItem

Returns

DiscordMediaGalleryItem

reverse.member?

optional member?: (bot, payload) => DiscordMember

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<Member, TProps, TBehavior>

Returns

DiscordMember

reverse.nameplate?

optional nameplate?: (bot, payload) => DiscordNameplate

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<Nameplate, TProps, TBehavior>

Returns

DiscordNameplate

reverse.snowflake?

optional snowflake?: (snowflake) => string

Parameters

snowflake

BigString

Returns

string

reverse.team?

optional team?: (bot, payload) => DiscordTeam

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Team

Returns

DiscordTeam

reverse.unfurledMediaItem?

optional unfurledMediaItem?: (bot, payload) => DiscordUnfurledMediaItem

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

UnfurledMediaItem

Returns

DiscordUnfurledMediaItem

reverse.user?

optional user?: (bot, payload) => DiscordUser

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<User, TProps, TBehavior>

Returns

DiscordUser

role?

optional role?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordRole, Role, { guildId?: BigString; }>

roleColors?

optional roleColors?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordRoleColors, RoleColors, { }>

scheduledEvent?

optional scheduledEvent?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordScheduledEvent, ScheduledEvent, { }>

scheduledEventRecurrenceRule?

optional scheduledEventRecurrenceRule?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordScheduledEventRecurrenceRule, ScheduledEventRecurrenceRule, { }>

sessionStartLimit?

optional sessionStartLimit?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSessionStartLimit, SessionStartLimit, { }>

sharedClientTheme?

optional sharedClientTheme?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSharedClientTheme, SharedClientTheme, { }>

sku?

optional sku?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSku, Sku, { }>

snowflake?

optional snowflake?: (snowflake) => bigint

Parameters

snowflake

BigString

Returns

bigint

soundboardSound?

optional soundboardSound?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSoundboardSound, SoundboardSound, { }>

stageInstance?

optional stageInstance?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordStageInstance, StageInstance, { }>

sticker?

optional sticker?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSticker, Sticker, { }>

stickerPack?

optional stickerPack?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordStickerPack, StickerPack, { }>

subscription?

optional subscription?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordSubscription, Subscription, { }>

team?

optional team?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordTeam, Team, { }>

teamMember?

optional teamMember?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordTeamMember, TeamMember, { }>

template?

optional template?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordTemplate, Template, { }>

threadMember?

optional threadMember?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordThreadMember, ThreadMember, ThreadMemberTransformerExtra>

threadMemberGuildCreate?

optional threadMemberGuildCreate?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordThreadMemberGuildCreate, ThreadMemberGuildCreate, { }>

unfurledMediaItem?

optional unfurledMediaItem?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordUnfurledMediaItem, UnfurledMediaItem, { }>

user?

optional user?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordUser, User, { }>

userPrimaryGuild?

optional userPrimaryGuild?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordUserPrimaryGuild, UserPrimaryGuild, { }>

voiceRegion?

optional voiceRegion?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordVoiceRegion, VoiceRegion, { }>

voiceState?

optional voiceState?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordVoiceState, VoiceState, { guildId?: BigString; }>

webhook?

optional webhook?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordWebhook, Webhook, { }>

welcomeScreen?

optional welcomeScreen?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordWelcomeScreen, WelcomeScreen, { }>

welcomeScreenChannel?

optional welcomeScreenChannel?: TransformerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordWelcomeScreenChannel, WelcomeScreenChannel, { }>