CreateBotOptions

Documentation

---

Documentation / @discordeno/bot / CreateBotOptions

Interface: CreateBotOptions<TProps, TBehavior>

Defined in: bot.ts:106

Type Parameters

TProps

TProps extends RecursivePartial<TransformersDesiredProperties>

TBehavior

TBehavior extends DesiredPropertiesBehavior

Properties

applicationId?

optional applicationId: BigString

Defined in: bot.ts:110

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

---

desiredProperties

desiredProperties: TProps

Defined in: bot.ts:126

Set the desired properties for the bot

---

desiredPropertiesBehavior?

optional desiredPropertiesBehavior: TBehavior

Defined in: bot.ts:132

Set the desired properties behavior for undesired properties

Default

DesiredPropertiesBehavior.RemoveKey

---

events?

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

Defined in: bot.ts:118

The event handlers.

---

gateway?

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

Defined in: bot.ts:116

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:122

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

---

intents?

optional intents: GatewayIntents

Defined in: bot.ts:112

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:141

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:114

Any options you wish to provide to the rest manager.

---

token

token: string

Defined in: bot.ts:108

The bot's token.

---

transformers?

optional transformers: object

Defined in: bot.ts:120

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

activity?

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

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, { }>

applicationCommandPermission?

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

attachment?

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

auditLogEntry?

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

automodActionExecution?

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

automodRule?

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

avatarDecorationData?

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

channel?

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

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, SetupDesiredProps<Activity, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

customizers.activityInstance?

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

customizers.activityLocation?

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

customizers.application?

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

customizers.applicationCommand?

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

customizers.applicationCommandOption?

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

customizers.applicationCommandOptionChoice?

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

customizers.applicationCommandPermission?

optional applicationCommandPermission: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildApplicationCommandPermissions, SetupDesiredProps<GuildApplicationCommandPermissions, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

customizers.attachment?

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

customizers.auditLogEntry?

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

customizers.automodActionExecution?

optional automodActionExecution: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationActionExecution, SetupDesiredProps<AutoModerationActionExecution, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

customizers.automodRule?

optional automodRule: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordAutoModerationRule, SetupDesiredProps<AutoModerationRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

customizers.avatarDecorationData?

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

customizers.channel?

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

customizers.collectibles?

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

customizers.component?

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

customizers.defaultReactionEmoji?

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

customizers.embed?

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

customizers.emoji?

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

customizers.entitlement?

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

customizers.forumTag?

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

customizers.gatewayBot?

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

customizers.guild?

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

customizers.guildOnboarding?

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

customizers.guildOnboardingPrompt?

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

customizers.guildOnboardingPromptOption?

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

customizers.incidentsData?

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

customizers.integration?

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

customizers.interaction?

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

customizers.interactionCallback?

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

customizers.interactionCallbackResponse?

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

customizers.interactionDataOptions?

optional interactionDataOptions: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordInteractionDataOption, SetupDesiredProps<InteractionDataOption, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

customizers.interactionDataResolved?

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

customizers.interactionResource?

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

customizers.invite?

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

customizers.inviteStageInstance?

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

customizers.lobby?

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

customizers.lobbyMember?

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

customizers.mediaGalleryItem?

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

customizers.member?

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

customizers.message?

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

customizers.messageCall?

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

customizers.messageInteractionMetadata?

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

customizers.messagePin?

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

customizers.messageSnapshot?

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

customizers.nameplate?

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

customizers.poll?

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

customizers.pollMedia?

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

customizers.presence?

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

customizers.role?

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

customizers.roleColors?

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

customizers.scheduledEvent?

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

customizers.scheduledEventRecurrenceRule?

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

customizers.sku?

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

customizers.soundboardSound?

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

customizers.stageInstance?

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

customizers.sticker?

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

customizers.stickerPack?

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

customizers.subscription?

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

customizers.team?

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

customizers.template?

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

customizers.threadMember?

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

customizers.threadMemberGuildCreate?

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

customizers.unfurledMediaItem?

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

customizers.user?

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

customizers.userPrimaryGuild?

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

customizers.voiceRegion?

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

customizers.voiceState?

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

customizers.webhook?

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

customizers.welcomeScreen?

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

customizers.widget?

optional widget: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildWidget, SetupDesiredProps<GuildWidget, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

customizers.widgetSettings?

optional widgetSettings: TransformerCustomizerFunction<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior, DiscordGuildWidgetSettings, SetupDesiredProps<GuildWidgetSettings, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>, BigStringsToBigints<{ }>>

defaultReactionEmoji?

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

embed?

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

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; }>

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, { }>

incidentsData?

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

integration?

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

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; }>

interactionDataOptions?

optional interactionDataOptions: 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 | DiscordInviteCreate, 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, { }>

lobbyMember?

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

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, { }>

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.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.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.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, { }>

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, { }>

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, { }>

widget?

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

widgetSettings?

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