Transformers

@discordeno/bot • Docs

---

Documentation / @discordeno/bot / Transformers

Interface: Transformers<TProps, TBehavior, TBot>

Type Parameters

• TProps extends TransformersDesiredProperties

• TBehavior extends DesiredPropertiesBehavior

• TBot extends Bot<TProps, TBehavior> = Bot<TProps, TBehavior>

Properties

activity()

activity: (bot, payload) => Activity

Parameters

• bot: TBot

• payload: DiscordActivity

Returns

Activity

Defined in

packages/bot/src/transformers.ts:328

---

activityInstance()

activityInstance: (bot, payload) => TBot["transformers"]["$inferredTypes"]["activityInstance"]

Parameters

• bot: TBot

• payload: DiscordActivityInstance

Returns

TBot["transformers"]["$inferredTypes"]["activityInstance"]

Defined in

packages/bot/src/transformers.ts:329

---

activityLocation()

activityLocation: (bot, payload) => TBot["transformers"]["$inferredTypes"]["activityLocation"]

Parameters

• bot: TBot

• payload: DiscordActivityLocation

Returns

TBot["transformers"]["$inferredTypes"]["activityLocation"]

Defined in

packages/bot/src/transformers.ts:330

---

application()

application: (bot, payload) => Application

Parameters

• bot: TBot

• payload

• payload.application: DiscordApplication

• payload.shardId: number

Returns

Application

Defined in

packages/bot/src/transformers.ts:331

---

applicationCommand()

applicationCommand: (bot, payload) => ApplicationCommand

Parameters

• bot: TBot

• payload: DiscordApplicationCommand

Returns

ApplicationCommand

Defined in

packages/bot/src/transformers.ts:332

---

applicationCommandOption()

applicationCommandOption: (bot, payload) => ApplicationCommandOption

Parameters

• bot: TBot

• payload: DiscordApplicationCommandOption

Returns

ApplicationCommandOption

Defined in

packages/bot/src/transformers.ts:333

---

applicationCommandOptionChoice()

applicationCommandOptionChoice: (bot, payload) => ApplicationCommandOptionChoice

Parameters

• bot: TBot

• payload: DiscordApplicationCommandOptionChoice

Returns

ApplicationCommandOptionChoice

Defined in

packages/bot/src/transformers.ts:334

---

applicationCommandPermission()

applicationCommandPermission: (bot, payload) => GuildApplicationCommandPermissions

Parameters

• bot: TBot

• payload: DiscordGuildApplicationCommandPermissions

Returns

GuildApplicationCommandPermissions

Defined in

packages/bot/src/transformers.ts:335

---

attachment()

attachment: (bot, payload) => TBot["transformers"]["$inferredTypes"]["attachment"]

Parameters

• bot: TBot

• payload: DiscordAttachment

Returns

TBot["transformers"]["$inferredTypes"]["attachment"]

Defined in

packages/bot/src/transformers.ts:336

---

auditLogEntry()

auditLogEntry: (bot, payload) => AuditLogEntry

Parameters

• bot: TBot

• payload: DiscordAuditLogEntry

Returns

AuditLogEntry

Defined in

packages/bot/src/transformers.ts:337

---

automodActionExecution()

automodActionExecution: (bot, payload) => AutoModerationActionExecution

Parameters

• bot: TBot

• payload: DiscordAutoModerationActionExecution

Returns

AutoModerationActionExecution

Defined in

packages/bot/src/transformers.ts:338

---

automodRule()

automodRule: (bot, payload) => AutoModerationRule

Parameters

• bot: TBot

• payload: DiscordAutoModerationRule

Returns

AutoModerationRule

Defined in

packages/bot/src/transformers.ts:339

---

avatarDecorationData()

avatarDecorationData: (bot, payload) => TBot["transformers"]["$inferredTypes"]["avatarDecorationData"]

Parameters

• bot: TBot

• payload: DiscordAvatarDecorationData

Returns

TBot["transformers"]["$inferredTypes"]["avatarDecorationData"]

Defined in

packages/bot/src/transformers.ts:340

---

channel()

channel: (bot, payload) => TBot["transformers"]["$inferredTypes"]["channel"]

Parameters

• bot: TBot

• payload

• payload.channel: DiscordChannel

• payload.guildId?: BigString

Returns

TBot["transformers"]["$inferredTypes"]["channel"]

Defined in

packages/bot/src/transformers.ts:341

---

component()

component: (bot, payload) => Component

Parameters

• bot: TBot

• payload: DiscordMessageComponent

Returns

Component

Defined in

packages/bot/src/transformers.ts:342

---

customizers

customizers: object

activity()

activity: (bot, payload, activity) => any

Parameters

• bot: TBot

• payload: DiscordActivity

• activity: Activity

Returns

any

activityInstance()

activityInstance: (bot, payload, activityInstance) => any

Parameters

• bot: TBot

• payload: DiscordActivityInstance

• activityInstance: TBot["transformers"]["$inferredTypes"]["activityInstance"]

Returns

any

activityLocation()

activityLocation: (bot, payload, activityLocation) => any

Parameters

• bot: TBot

• payload: DiscordActivityLocation

• activityLocation: TBot["transformers"]["$inferredTypes"]["activityLocation"]

Returns

any

application()

application: (bot, payload, application) => any

Parameters

• bot: TBot

• payload: DiscordApplication

• application: Application

Returns

any

applicationCommand()

applicationCommand: (bot, payload, applicationCommand) => any

Parameters

• bot: TBot

• payload: DiscordApplicationCommand

• applicationCommand: ApplicationCommand

Returns

any

applicationCommandOption()

applicationCommandOption: (bot, payload, applicationCommandOption) => any

Parameters

• bot: TBot

• payload: DiscordApplicationCommandOption

• applicationCommandOption: ApplicationCommandOption

Returns

any

applicationCommandOptionChoice()

applicationCommandOptionChoice: (bot, payload, applicationCommandOptionChoice) => any

Parameters

• bot: TBot

• payload: DiscordApplicationCommandOptionChoice

• applicationCommandOptionChoice: ApplicationCommandOptionChoice

Returns

any

applicationCommandPermission()

applicationCommandPermission: (bot, payload, applicationCommandPermission) => any

Parameters

• bot: TBot

• payload: DiscordGuildApplicationCommandPermissions

• applicationCommandPermission: GuildApplicationCommandPermissions

Returns

any

attachment()

attachment: (bot, payload, attachment) => any

Parameters

• bot: TBot

• payload: DiscordAttachment

• attachment: TBot["transformers"]["$inferredTypes"]["attachment"]

Returns

any

auditLogEntry()

auditLogEntry: (bot, payload, auditLogEntry) => any

Parameters

• bot: TBot

• payload: DiscordAuditLogEntry

• auditLogEntry: AuditLogEntry

Returns

any

automodActionExecution()

automodActionExecution: (bot, payload, automodActionExecution) => any

Parameters

• bot: TBot

• payload: DiscordAutoModerationActionExecution

• automodActionExecution: AutoModerationActionExecution

Returns

any

automodRule()

automodRule: (bot, payload, automodRule) => any

Parameters

• bot: TBot

• payload: DiscordAutoModerationRule

• automodRule: AutoModerationRule

Returns

any

avatarDecorationData()

avatarDecorationData: (bot, payload, avatarDecorationData) => any

Parameters

• bot: TBot

• payload: DiscordAvatarDecorationData

• avatarDecorationData: TBot["transformers"]["$inferredTypes"]["avatarDecorationData"]

Returns

any

channel()

channel: (bot, payload, channel) => any

Parameters

• bot: TBot

• payload: DiscordChannel

• channel: TBot["transformers"]["$inferredTypes"]["channel"]

Returns

any

component()

component: (bot, payload, component) => any

Parameters

• bot: TBot

• payload: DiscordMessageComponent

• component: Component

Returns

any

defaultReactionEmoji()

defaultReactionEmoji: (bot, payload, defaultReactionEmoji) => any

Parameters

• bot: TBot

• payload: DiscordDefaultReactionEmoji

• defaultReactionEmoji: TBot["transformers"]["$inferredTypes"]["defaultReactionEmoji"]

Returns

any

embed()

embed: (bot, payload, embed) => any

Parameters

• bot: TBot

• payload: DiscordEmbed

• embed: Embed

Returns

any

emoji()

emoji: (bot, payload, emoji) => any

Parameters

• bot: TBot

• payload: DiscordEmoji

• emoji: TBot["transformers"]["$inferredTypes"]["emoji"]

Returns

any

entitlement()

entitlement: (bot, payload, entitlement) => any

Parameters

• bot: TBot

• payload: DiscordEntitlement

• entitlement: TBot["transformers"]["$inferredTypes"]["entitlement"]

Returns

any

forumTag()

forumTag: (bot, payload, forumTag) => any

Parameters

• bot: TBot

• payload: DiscordForumTag

• forumTag: TBot["transformers"]["$inferredTypes"]["forumTag"]

Returns

any

gatewayBot()

gatewayBot: (bot, payload, getGatewayBot) => any

Parameters

• bot: TBot

• payload: DiscordGetGatewayBot

• getGatewayBot: GetGatewayBot

Returns

any

guild()

guild: (bot, payload, guild) => any

Parameters

• bot: TBot

• payload: DiscordGuild

• guild: TBot["transformers"]["$inferredTypes"]["guild"]

Returns

any

guildOnboarding()

guildOnboarding: (bot, payload, onboarding) => any

Parameters

• bot: TBot

• payload: DiscordGuildOnboarding

• onboarding: TBot["transformers"]["$inferredTypes"]["guildOnboarding"]

Returns

any

guildOnboardingPrompt()

guildOnboardingPrompt: (bot, payload, onboardingPrompt) => any

Parameters

• bot: TBot

• payload: DiscordGuildOnboardingPrompt

• onboardingPrompt: TBot["transformers"]["$inferredTypes"]["guildOnboardingPrompt"]

Returns

any

guildOnboardingPromptOption()

guildOnboardingPromptOption: (bot, payload, onboardingPromptOption) => any

Parameters

• bot: TBot

• payload: DiscordGuildOnboardingPromptOption

• onboardingPromptOption: GuildOnboardingPromptOption

Returns

any

integration()

integration: (bot, payload, integration) => any

Parameters

• bot: TBot

• payload: DiscordIntegrationCreateUpdate

• integration: Integration

Returns

any

interaction()

interaction: (bot, payload, interaction) => any

Parameters

• bot: TBot

• payload

• payload.interaction: DiscordInteraction

• payload.shardId: number

• interaction: TBot["transformers"]["$inferredTypes"]["interaction"]

Returns

any

interactionCallback()

interactionCallback: (bot, payload, interactionCallback) => any

Parameters

• bot: TBot

• payload: DiscordInteractionCallback

• interactionCallback: TBot["transformers"]["$inferredTypes"]["interactionCallback"]

Returns

any

interactionCallbackResponse()

interactionCallbackResponse: (bot, payload, interactionCallbackResponse) => any

Parameters

• bot: TBot

• payload: DiscordInteractionCallbackResponse

• interactionCallbackResponse: TBot["transformers"]["$inferredTypes"]["interactionCallbackResponse"]

Returns

any

interactionDataOptions()

interactionDataOptions: (bot, payload, interactionDataOptions) => any

Parameters

• bot: TBot

• payload: DiscordInteractionDataOption

• interactionDataOptions: InteractionDataOption

Returns

any

interactionDataResolved()

interactionDataResolved: (bot, payload, interactionDataResolved) => any

Parameters

• bot: TBot

• payload

• payload.guildId?: bigint

• payload.resolved: DiscordInteractionDataResolved

• interactionDataResolved: InteractionDataResolved

Returns

any

interactionResource()

interactionResource: (bot, payload, interactionResource) => any

Parameters

• bot: TBot

• payload: DiscordInteractionResource

• interactionResource: TBot["transformers"]["$inferredTypes"]["interactionResource"]

Returns

any

invite()

invite: (bot, payload, invite) => any

Parameters

• bot: TBot

• payload: DiscordInviteCreate | DiscordInviteMetadata

• invite: TBot["transformers"]["$inferredTypes"]["invite"]

Returns

any

inviteStageInstance()

inviteStageInstance: (bot, payload, inviteStageInstance) => any

Parameters

• bot: TBot

• payload: DiscordInviteStageInstance

• inviteStageInstance: TBot["transformers"]["$inferredTypes"]["inviteStageInstance"]

Returns

any

member()

member: (bot, payload, member) => any

Parameters

• bot: TBot

• payload: DiscordMember

• member: TBot["transformers"]["$inferredTypes"]["member"]

Returns

any

message()

message: (bot, payload, message) => any

Parameters

• bot: TBot

• payload: DiscordMessage

• message: TBot["transformers"]["$inferredTypes"]["message"]

Returns

any

messageCall()

messageCall: (bot, payload, call) => any

Parameters

• bot: TBot

• payload: DiscordMessageCall

• call: TBot["transformers"]["$inferredTypes"]["messageCall"]

Returns

any

messageInteractionMetadata()

messageInteractionMetadata: (bot, payload, metadata) => any

Parameters

• bot: TBot

• payload: DiscordMessageInteractionMetadata

• metadata: TBot["transformers"]["$inferredTypes"]["messageInteractionMetadata"]

Returns

any

messageSnapshot()

messageSnapshot: (bot, payload, messageSnapshot) => any

Parameters

• bot: TBot

• payload: DiscordMessageSnapshot

• messageSnapshot: TBot["transformers"]["$inferredTypes"]["messageSnapshot"]

Returns

any

poll()

poll: (bot, payload, poll) => any

Parameters

• bot: TBot

• payload: DiscordPoll

• poll: TBot["transformers"]["$inferredTypes"]["poll"]

Returns

any

pollMedia()

pollMedia: (bot, payload, pollMedia) => any

Parameters

• bot: TBot

• payload: DiscordPollMedia

• pollMedia: TBot["transformers"]["$inferredTypes"]["pollMedia"]

Returns

any

presence()

presence: (bot, payload, presence) => any

Parameters

• bot: TBot

• payload: DiscordPresenceUpdate

• presence: PresenceUpdate

Returns

any

role()

role: (bot, payload, role) => any

Parameters

• bot: TBot

• payload: DiscordRole

• role: TBot["transformers"]["$inferredTypes"]["role"]

Returns

any

scheduledEvent()

scheduledEvent: (bot, payload, scheduledEvent) => any

Parameters

• bot: TBot

• payload: DiscordScheduledEvent

• scheduledEvent: TBot["transformers"]["$inferredTypes"]["scheduledEvent"]

Returns

any

scheduledEventRecurrenceRule()

scheduledEventRecurrenceRule: (bot, payload, scheduledEvent) => any

Parameters

• bot: TBot

• payload: DiscordScheduledEventRecurrenceRule

• scheduledEvent: TBot["transformers"]["$inferredTypes"]["scheduledEventRecurrenceRule"]

Returns

any

sku()

sku: (bot, payload, sku) => any

Parameters

• bot: TBot

• payload: DiscordSku

• sku: TBot["transformers"]["$inferredTypes"]["sku"]

Returns

any

soundboardSound()

soundboardSound: (bot, payload, soundboardSound) => any

Parameters

• bot: TBot

• payload: DiscordSoundboardSound

• soundboardSound: TBot["transformers"]["$inferredTypes"]["soundboardSound"]

Returns

any

stageInstance()

stageInstance: (bot, payload, stageInstance) => any

Parameters

• bot: TBot

• payload: DiscordStageInstance

• stageInstance: TBot["transformers"]["$inferredTypes"]["stageInstance"]

Returns

any

sticker()

sticker: (bot, payload, sticker) => any

Parameters

• bot: TBot

• payload: DiscordSticker

• sticker: TBot["transformers"]["$inferredTypes"]["sticker"]

Returns

any

stickerPack()

stickerPack: (bot, payload, stickerPack) => any

Parameters

• bot: TBot

• payload: DiscordStickerPack

• stickerPack: StickerPack

Returns

any

subscription()

subscription: (bot, payload, subscription) => any

Parameters

• bot: TBot

• payload: DiscordSubscription

• subscription: TBot["transformers"]["$inferredTypes"]["subscription"]

Returns

any

team()

team: (bot, payload, team) => any

Parameters

• bot: TBot

• payload: DiscordTeam

• team: Team

Returns

any

template()

template: (bot, payload, template) => any

Parameters

• bot: TBot

• payload: DiscordTemplate

• template: Template

Returns

any

threadMember()

threadMember: (bot, payload, threadMember) => any

Parameters

• bot: TBot

• payload: DiscordThreadMember

• threadMember: ThreadMember

Returns

any

threadMemberGuildCreate()

threadMemberGuildCreate: (bot, payload, threadMemberGuildCreate) => any

Parameters

• bot: TBot

• payload: DiscordThreadMemberGuildCreate

• threadMemberGuildCreate: ThreadMemberGuildCreate

Returns

any

user()

user: (bot, payload, user) => any

Parameters

• bot: TBot

• payload: DiscordUser

• user: TBot["transformers"]["$inferredTypes"]["user"]

Returns

any

voiceRegion()

voiceRegion: (bot, payload, voiceRegion) => any

Parameters

• bot: TBot

• payload: DiscordVoiceRegion

• voiceRegion: VoiceRegion

Returns

any

voiceState()

voiceState: (bot, payload, voiceState) => any

Parameters

• bot: TBot

• payload: DiscordVoiceState

• voiceState: TBot["transformers"]["$inferredTypes"]["voiceState"]

Returns

any

webhook()

webhook: (bot, payload, webhook) => any

Parameters

• bot: TBot

• payload: DiscordWebhook

• webhook: TBot["transformers"]["$inferredTypes"]["webhook"]

Returns

any

welcomeScreen()

welcomeScreen: (bot, payload, welcomeScreen) => any

Parameters

• bot: TBot

• payload: DiscordWelcomeScreen

• welcomeScreen: WelcomeScreen

Returns

any

widget()

widget: (bot, payload, widget) => any

Parameters

• bot: TBot

• payload: DiscordGuildWidget

• widget: GuildWidget

Returns

any

widgetSettings()

widgetSettings: (bot, payload, widgetSettings) => any

Parameters

• bot: TBot

• payload: DiscordGuildWidgetSettings

• widgetSettings: GuildWidgetSettings

Returns

any

Defined in

packages/bot/src/transformers.ts:187

---

defaultReactionEmoji()

defaultReactionEmoji: (bot, payload) => TBot["transformers"]["$inferredTypes"]["defaultReactionEmoji"]

Parameters

• bot: TBot

• payload: DiscordDefaultReactionEmoji

Returns

TBot["transformers"]["$inferredTypes"]["defaultReactionEmoji"]

Defined in

packages/bot/src/transformers.ts:343

---

desiredProperties

desiredProperties: TransformersDesiredProperties

Defined in

packages/bot/src/transformers.ts:311

---

embed()

embed: (bot, payload) => Embed

Parameters

• bot: TBot

• payload: DiscordEmbed

Returns

Embed

Defined in

packages/bot/src/transformers.ts:344

---

emoji()

emoji: (bot, payload) => TBot["transformers"]["$inferredTypes"]["emoji"]

Parameters

• bot: TBot

• payload: DiscordEmoji

Returns

TBot["transformers"]["$inferredTypes"]["emoji"]

Defined in

packages/bot/src/transformers.ts:345

---

entitlement()

entitlement: (bot, payload) => TBot["transformers"]["$inferredTypes"]["entitlement"]

Parameters

• bot: TBot

• payload: DiscordEntitlement

Returns

TBot["transformers"]["$inferredTypes"]["entitlement"]

Defined in

packages/bot/src/transformers.ts:346

---

forumTag()

forumTag: (bot, payload) => TBot["transformers"]["$inferredTypes"]["forumTag"]

Parameters

• bot: TBot

• payload: DiscordForumTag

Returns

TBot["transformers"]["$inferredTypes"]["forumTag"]

Defined in

packages/bot/src/transformers.ts:347

---

gatewayBot()

gatewayBot: (bot, payload) => GetGatewayBot

Parameters

• bot: TBot

• payload: DiscordGetGatewayBot

Returns

GetGatewayBot

Defined in

packages/bot/src/transformers.ts:348

---

guild()

guild: (bot, payload) => TBot["transformers"]["$inferredTypes"]["guild"]

Parameters

• bot: TBot

• payload

• payload.guild: DiscordGuild

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["guild"]

Defined in

packages/bot/src/transformers.ts:349

---

guildOnboarding()

guildOnboarding: (bot, payload) => TBot["transformers"]["$inferredTypes"]["guildOnboarding"]

Parameters

• bot: TBot

• payload: DiscordGuildOnboarding

Returns

TBot["transformers"]["$inferredTypes"]["guildOnboarding"]

Defined in

packages/bot/src/transformers.ts:350

---

guildOnboardingPrompt()

guildOnboardingPrompt: (bot, payload) => TBot["transformers"]["$inferredTypes"]["guildOnboardingPrompt"]

Parameters

• bot: TBot

• payload: DiscordGuildOnboardingPrompt

Returns

TBot["transformers"]["$inferredTypes"]["guildOnboardingPrompt"]

Defined in

packages/bot/src/transformers.ts:351

---

guildOnboardingPromptOption()

guildOnboardingPromptOption: (bot, payload) => GuildOnboardingPromptOption

Parameters

• bot: TBot

• payload: DiscordGuildOnboardingPromptOption

Returns

GuildOnboardingPromptOption

Defined in

packages/bot/src/transformers.ts:352

---

integration()

integration: (bot, payload) => Integration

Parameters

• bot: TBot

• payload: DiscordIntegrationCreateUpdate

Returns

Integration

Defined in

packages/bot/src/transformers.ts:353

---

interaction()

interaction: (bot, payload) => TBot["transformers"]["$inferredTypes"]["interaction"]

Parameters

• bot: TBot

• payload

• payload.interaction: DiscordInteraction

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["interaction"]

Defined in

packages/bot/src/transformers.ts:354

---

interactionCallback()

interactionCallback: (bot, payload) => TBot["transformers"]["$inferredTypes"]["interactionCallback"]

Parameters

• bot: TBot

• payload: DiscordInteractionCallback

Returns

TBot["transformers"]["$inferredTypes"]["interactionCallback"]

Defined in

packages/bot/src/transformers.ts:355

---

interactionCallbackResponse()

interactionCallbackResponse: (bot, payload) => TBot["transformers"]["$inferredTypes"]["interactionCallbackResponse"]

Parameters

• bot: TBot

• payload

• payload.interactionCallbackResponse: DiscordInteractionCallbackResponse

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["interactionCallbackResponse"]

Defined in

packages/bot/src/transformers.ts:356

---

interactionDataOptions()

interactionDataOptions: (bot, payload) => InteractionDataOption

Parameters

• bot: TBot

• payload: DiscordInteractionDataOption

Returns

InteractionDataOption

Defined in

packages/bot/src/transformers.ts:360

---

interactionDataResolved()

interactionDataResolved: (bot, payload) => InteractionDataResolved

Parameters

• bot: TBot

• payload

• payload.guildId?: bigint

• payload.resolved: DiscordInteractionDataResolved

• payload.shardId: number

Returns

InteractionDataResolved

Defined in

packages/bot/src/transformers.ts:361

---

interactionResource()

interactionResource: (bot, payload) => TBot["transformers"]["$inferredTypes"]["interactionResource"]

Parameters

• bot: TBot

• payload

• payload.interactionResource: DiscordInteractionResource

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["interactionResource"]

Defined in

packages/bot/src/transformers.ts:365

---

invite()

invite: (bot, payload) => TBot["transformers"]["$inferredTypes"]["invite"]

Parameters

• bot: TBot

• payload

• payload.invite: DiscordInviteCreate | DiscordInviteMetadata

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["invite"]

Defined in

packages/bot/src/transformers.ts:369

---

inviteStageInstance()

inviteStageInstance: (bot, payload) => TBot["transformers"]["$inferredTypes"]["inviteStageInstance"]

Parameters

• bot: TBot

• payload: DiscordInviteStageInstance & object

Returns

TBot["transformers"]["$inferredTypes"]["inviteStageInstance"]

Defined in

packages/bot/src/transformers.ts:373

---

member()

member: (bot, payload, guildId, userId) => TBot["transformers"]["$inferredTypes"]["member"]

Parameters

• bot: TBot

• payload: DiscordMember

• guildId: BigString

• userId: BigString

Returns

TBot["transformers"]["$inferredTypes"]["member"]

Defined in

packages/bot/src/transformers.ts:377

---

message()

message: (bot, payload) => TBot["transformers"]["$inferredTypes"]["message"]

Parameters

• bot: TBot

• payload

• payload.message: DiscordMessage

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["message"]

Defined in

packages/bot/src/transformers.ts:378

---

messageCall()

messageCall: (bot, payload) => TBot["transformers"]["$inferredTypes"]["messageCall"]

Parameters

• bot: TBot

• payload: DiscordMessageCall

Returns

TBot["transformers"]["$inferredTypes"]["messageCall"]

Defined in

packages/bot/src/transformers.ts:379

---

messageInteractionMetadata()

messageInteractionMetadata: (bot, payload) => TBot["transformers"]["$inferredTypes"]["messageInteractionMetadata"]

Parameters

• bot: TBot

• payload: DiscordMessageInteractionMetadata

Returns

TBot["transformers"]["$inferredTypes"]["messageInteractionMetadata"]

Defined in

packages/bot/src/transformers.ts:380

---

messageSnapshot()

messageSnapshot: (bot, payload) => TBot["transformers"]["$inferredTypes"]["messageSnapshot"]

Parameters

• bot: TBot

• payload

• payload.messageSnapshot: DiscordMessageSnapshot

• payload.shardId: number

Returns

TBot["transformers"]["$inferredTypes"]["messageSnapshot"]

Defined in

packages/bot/src/transformers.ts:384

---

poll()

poll: (bot, payload) => TBot["transformers"]["$inferredTypes"]["poll"]

Parameters

• bot: TBot

• payload: DiscordPoll

Returns

TBot["transformers"]["$inferredTypes"]["poll"]

Defined in

packages/bot/src/transformers.ts:388

---

pollMedia()

pollMedia: (bot, payload) => TBot["transformers"]["$inferredTypes"]["pollMedia"]

Parameters

• bot: TBot

• payload: DiscordPollMedia

Returns

TBot["transformers"]["$inferredTypes"]["pollMedia"]

Defined in

packages/bot/src/transformers.ts:389

---

presence()

presence: (bot, payload) => PresenceUpdate

Parameters

• bot: TBot

• payload: DiscordPresenceUpdate

Returns

PresenceUpdate

Defined in

packages/bot/src/transformers.ts:390

---

reverse

reverse: object

activity()

activity: (bot, payload) => DiscordActivity

Parameters

• bot: TBot

• payload: Activity

Returns

DiscordActivity

allowedMentions()

allowedMentions: (bot, payload) => DiscordAllowedMentions

Parameters

• bot: TBot

• payload: AllowedMentions

Returns

DiscordAllowedMentions

application()

application: (bot, payload) => DiscordApplication

Parameters

• bot: TBot

• payload: Application

Returns

DiscordApplication

applicationCommand()

applicationCommand: (bot, payload) => DiscordApplicationCommand

Parameters

• bot: TBot

• payload: ApplicationCommand

Returns

DiscordApplicationCommand

applicationCommandOption()

applicationCommandOption: (bot, payload) => DiscordApplicationCommandOption

Parameters

• bot: TBot

• payload: ApplicationCommandOption

Returns

DiscordApplicationCommandOption

applicationCommandOptionChoice()

applicationCommandOptionChoice: (bot, payload) => DiscordApplicationCommandOptionChoice

Parameters

• bot: TBot

• payload: ApplicationCommandOptionChoice

Returns

DiscordApplicationCommandOptionChoice

attachment()

attachment: (bot, payload) => DiscordAttachment

Parameters

• bot: TBot

• payload: TBot["transformers"]["$inferredTypes"]["attachment"]

Returns

DiscordAttachment

component()

component: (bot, payload) => DiscordMessageComponent

Parameters

• bot: TBot

• payload: Component

Returns

DiscordMessageComponent

createApplicationCommand()

createApplicationCommand: (bot, payload) => DiscordCreateApplicationCommand

Parameters

• bot: TBot

• payload: CreateApplicationCommand

Returns

DiscordCreateApplicationCommand

embed()

embed: (bot, payload) => DiscordEmbed

Parameters

• bot: TBot

• payload: Embed

Returns

DiscordEmbed

member()

member: (bot, payload) => DiscordMember

Parameters

• bot: TBot

• payload: TBot["transformers"]["$inferredTypes"]["member"]

Returns

DiscordMember

snowflake()

snowflake: (snowflake) => string

Parameters

• snowflake: BigString

Returns

string

team()

team: (bot, payload) => DiscordTeam

Parameters

• bot: TBot

• payload: Team

Returns

DiscordTeam

user()

user: (bot, payload) => DiscordUser

Parameters

• bot: TBot

• payload: TBot["transformers"]["$inferredTypes"]["user"]

Returns

DiscordUser

Defined in

packages/bot/src/transformers.ts:312

---

role()

role: (bot, payload) => TBot["transformers"]["$inferredTypes"]["role"]

Parameters

• bot: TBot

• payload

• payload.guildId: BigString

• payload.role: DiscordRole

Returns

TBot["transformers"]["$inferredTypes"]["role"]

Defined in

packages/bot/src/transformers.ts:391

---

scheduledEvent()

scheduledEvent: (bot, payload) => TBot["transformers"]["$inferredTypes"]["scheduledEvent"]

Parameters

• bot: TBot

• payload: DiscordScheduledEvent

Returns

TBot["transformers"]["$inferredTypes"]["scheduledEvent"]

Defined in

packages/bot/src/transformers.ts:392

---

scheduledEventRecurrenceRule()

scheduledEventRecurrenceRule: (bot, payload) => TBot["transformers"]["$inferredTypes"]["scheduledEventRecurrenceRule"]

Parameters

• bot: TBot

• payload: DiscordScheduledEventRecurrenceRule

Returns

TBot["transformers"]["$inferredTypes"]["scheduledEventRecurrenceRule"]

Defined in

packages/bot/src/transformers.ts:393

---

sku()

sku: (bot, payload) => TBot["transformers"]["$inferredTypes"]["sku"]

Parameters

• bot: TBot

• payload: DiscordSku

Returns

TBot["transformers"]["$inferredTypes"]["sku"]

Defined in

packages/bot/src/transformers.ts:397

---

snowflake()

snowflake: (snowflake) => bigint

Parameters

• snowflake: BigString

Returns

bigint

Defined in

packages/bot/src/transformers.ts:399

---

soundboardSound()

soundboardSound: (bot, payload) => TBot["transformers"]["$inferredTypes"]["soundboardSound"]

Parameters

• bot: TBot

• payload: DiscordSoundboardSound

Returns

TBot["transformers"]["$inferredTypes"]["soundboardSound"]

Defined in

packages/bot/src/transformers.ts:398

---

stageInstance()

stageInstance: (bot, payload) => TBot["transformers"]["$inferredTypes"]["stageInstance"]

Parameters

• bot: TBot

• payload: DiscordStageInstance

Returns

TBot["transformers"]["$inferredTypes"]["stageInstance"]

Defined in

packages/bot/src/transformers.ts:400

---

sticker()

sticker: (bot, payload) => TBot["transformers"]["$inferredTypes"]["sticker"]

Parameters

• bot: TBot

• payload: DiscordSticker

Returns

TBot["transformers"]["$inferredTypes"]["sticker"]

Defined in

packages/bot/src/transformers.ts:401

---

stickerPack()

stickerPack: (bot, payload) => StickerPack

Parameters

• bot: TBot

• payload: DiscordStickerPack

Returns

StickerPack

Defined in

packages/bot/src/transformers.ts:402

---

subscription()

subscription: (bot, payload) => TBot["transformers"]["$inferredTypes"]["subscription"]

Parameters

• bot: TBot

• payload: DiscordSubscription

Returns

TBot["transformers"]["$inferredTypes"]["subscription"]

Defined in

packages/bot/src/transformers.ts:403

---

team()

team: (bot, payload) => Team

Parameters

• bot: TBot

• payload: DiscordTeam

Returns

Team

Defined in

packages/bot/src/transformers.ts:404

---

template()

template: (bot, payload) => Template

Parameters

• bot: TBot

• payload: DiscordTemplate

Returns

Template

Defined in

packages/bot/src/transformers.ts:405

---

threadMember()

threadMember: (bot, payload) => ThreadMember

Parameters

• bot: TBot

• payload: DiscordThreadMember

Returns

ThreadMember

Defined in

packages/bot/src/transformers.ts:406

---

threadMemberGuildCreate()

threadMemberGuildCreate: (bot, payload) => ThreadMemberGuildCreate

Parameters

• bot: TBot

• payload: DiscordThreadMemberGuildCreate

Returns

ThreadMemberGuildCreate

Defined in

packages/bot/src/transformers.ts:407

---

user()

user: (bot, payload) => TBot["transformers"]["$inferredTypes"]["user"]

Parameters

• bot: TBot

• payload: DiscordUser

Returns

TBot["transformers"]["$inferredTypes"]["user"]

Defined in

packages/bot/src/transformers.ts:408

---

voiceRegion()

voiceRegion: (bot, payload) => VoiceRegion

Parameters

• bot: TBot

• payload: DiscordVoiceRegion

Returns

VoiceRegion

Defined in

packages/bot/src/transformers.ts:409

---

voiceState()

voiceState: (bot, payload) => TBot["transformers"]["$inferredTypes"]["voiceState"]

Parameters

• bot: TBot

• payload

• payload.guildId: BigString

• payload.voiceState: DiscordVoiceState

Returns

TBot["transformers"]["$inferredTypes"]["voiceState"]

Defined in

packages/bot/src/transformers.ts:410

---

webhook()

webhook: (bot, payload) => TBot["transformers"]["$inferredTypes"]["webhook"]

Parameters

• bot: TBot

• payload: DiscordWebhook

Returns

TBot["transformers"]["$inferredTypes"]["webhook"]

Defined in

packages/bot/src/transformers.ts:411

---

welcomeScreen()

welcomeScreen: (bot, payload) => WelcomeScreen

Parameters

• bot: TBot

• payload: DiscordWelcomeScreen

Returns

WelcomeScreen

Defined in

packages/bot/src/transformers.ts:412

---

widget()

widget: (bot, payload) => GuildWidget

Parameters

• bot: TBot

• payload: DiscordGuildWidget

Returns

GuildWidget

Defined in

packages/bot/src/transformers.ts:413

---

widgetSettings()

widgetSettings: (bot, payload) => GuildWidgetSettings

Parameters

• bot: TBot

• payload: DiscordGuildWidgetSettings

Returns

GuildWidgetSettings

Defined in

packages/bot/src/transformers.ts:414