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?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordActivity

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

activityAssets?

optional activityAssets?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordActivityAssets

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

activityInstance?

optional activityInstance?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordActivityInstance

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

activityLocation?

optional activityLocation?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordActivityLocation

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

application?

optional application?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordApplication

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

applicationCommand?

optional applicationCommand?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordApplicationCommand

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

applicationCommandOption?

optional applicationCommandOption?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordApplicationCommandOption

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

applicationCommandOptionChoice?

optional applicationCommandOptionChoice?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordApplicationCommandOptionChoice

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

applicationCommandPermission?

optional applicationCommandPermission?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuildApplicationCommandPermissions

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

attachment?

optional attachment?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordAttachment

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

auditLogEntry?

optional auditLogEntry?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordAuditLogEntry

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

automodActionExecution?

optional automodActionExecution?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordAutoModerationActionExecution

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

automodRule?

optional automodRule?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordAutoModerationRule

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

avatarDecorationData?

optional avatarDecorationData?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordAvatarDecorationData

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

channel?

optional channel?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordChannel

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

collectibles?

optional collectibles?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordCollectibles

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

component?

optional component?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

customizers?

optional customizers?: object

customizers.activity?

optional activity?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordActivity

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.activityAssets?

optional activityAssets?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordActivityAssets

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.activityInstance?

optional activityInstance?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordActivityInstance

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.activityLocation?

optional activityLocation?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordActivityLocation

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.application?

optional application?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordApplication

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.applicationCommand?

optional applicationCommand?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordApplicationCommand

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.applicationCommandOption?

optional applicationCommandOption?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordApplicationCommandOption

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.applicationCommandOptionChoice?

optional applicationCommandOptionChoice?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordApplicationCommandOptionChoice

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.applicationCommandPermission?

optional applicationCommandPermission?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordGuildApplicationCommandPermissions

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.attachment?

optional attachment?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordAttachment

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.auditLogEntry?

optional auditLogEntry?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordAuditLogEntry

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.automodActionExecution?

optional automodActionExecution?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordAutoModerationActionExecution

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.automodRule?

optional automodRule?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordAutoModerationRule

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.avatarDecorationData?

optional avatarDecorationData?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordAvatarDecorationData

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.channel?

optional channel?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordChannel

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

customizers.collectibles?

optional collectibles?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordCollectibles

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.component?

optional component?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<DiscordMessageComponent | DiscordMessageComponentFromModalInteractionResponse>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.defaultReactionEmoji?

optional defaultReactionEmoji?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordDefaultReactionEmoji

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.embed?

optional embed?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordEmbed

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.emoji?

optional emoji?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordEmoji

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.entitlement?

optional entitlement?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordEntitlement

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.forumTag?

optional forumTag?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordForumTag

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.gatewayBot?

optional gatewayBot?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordGetGatewayBot

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.guild?

optional guild?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordGuild

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.guildOnboarding?

optional guildOnboarding?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordGuildOnboarding

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.guildOnboardingPrompt?

optional guildOnboardingPrompt?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordGuildOnboardingPrompt

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.guildOnboardingPromptOption?

optional guildOnboardingPromptOption?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordGuildOnboardingPromptOption

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.incidentsData?

optional incidentsData?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordIncidentsData

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.integration?

optional integration?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordIntegrationCreateUpdate

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.interaction?

optional interaction?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInteraction

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.interactionCallback?

optional interactionCallback?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInteractionCallback

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.interactionCallbackResponse?

optional interactionCallbackResponse?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInteractionCallbackResponse

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.interactionDataOptions?

optional interactionDataOptions?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordInteractionDataOption

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.interactionDataResolved?

optional interactionDataResolved?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInteractionDataResolved

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ guildId?: BigString; shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ guildId?: BigString; shardId?: number; }> & object

Returns

any

customizers.interactionResource?

optional interactionResource?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInteractionResource

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.invite?

optional invite?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInviteMetadata

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.inviteStageInstance?

optional inviteStageInstance?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordInviteStageInstance

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

customizers.lobby?

optional lobby?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordLobby

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.lobbyInvite?

optional lobbyInvite?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordLobbyInvite

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.lobbyMember?

optional lobbyMember?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordLobbyMember

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.lobbyMessage?

optional lobbyMessage?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordLobbyMessage

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.mediaGalleryItem?

optional mediaGalleryItem?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMediaGalleryItem

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.member?

optional member?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMember

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ guildId?: BigString; userId?: BigString; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ guildId?: BigString; userId?: BigString; }> & object

Returns

any

customizers.message?

optional message?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMessage

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.messageCall?

optional messageCall?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMessageCall

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.messageInteractionMetadata?

optional messageInteractionMetadata?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMessageInteractionMetadata

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<DiscordMessageInteractionMetadata>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.messagePin?

optional messagePin?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMessagePin

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.messageSnapshot?

optional messageSnapshot?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordMessageSnapshot

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ shardId?: number; }> & object

Returns

any

customizers.nameplate?

optional nameplate?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordNameplate

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.poll?

optional poll?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordPoll

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.pollMedia?

optional pollMedia?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordPollMedia

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.presence?

optional presence?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordPresenceUpdate

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.role?

optional role?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordRole

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

customizers.roleColors?

optional roleColors?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordRoleColors

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.scheduledEvent?

optional scheduledEvent?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordScheduledEvent

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.scheduledEventRecurrenceRule?

optional scheduledEventRecurrenceRule?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordScheduledEventRecurrenceRule

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.sharedClientTheme?

optional sharedClientTheme?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordSharedClientTheme

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.sku?

optional sku?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordSku

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.soundboardSound?

optional soundboardSound?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordSoundboardSound

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.stageInstance?

optional stageInstance?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordStageInstance

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.sticker?

optional sticker?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordSticker

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.stickerPack?

optional stickerPack?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordStickerPack

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.subscription?

optional subscription?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordSubscription

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.team?

optional team?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordTeam

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.template?

optional template?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordTemplate

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.threadMember?

optional threadMember?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordThreadMember

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<ThreadMemberTransformerExtra>

Returns

any

customizers.threadMemberGuildCreate?

optional threadMemberGuildCreate?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordThreadMemberGuildCreate

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.unfurledMediaItem?

optional unfurledMediaItem?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordUnfurledMediaItem

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.user?

optional user?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordUser

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.userPrimaryGuild?

optional userPrimaryGuild?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordUserPrimaryGuild

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.voiceRegion?

optional voiceRegion?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordVoiceRegion

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.voiceState?

optional voiceState?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordVoiceState

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ guildId?: BigString; }> & object

Returns

any

customizers.webhook?

optional webhook?: {(bot, payload, transformed, extra): any; (bot, payload, transformed, extra): any; }

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

DiscordWebhook

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra

BigStringsToBigints<{ }> & object

Returns

any

Call Signature

(bot, payload, transformed, extra): any

Parameters

bot

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

payload

Partial<TPayload>

transformed

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

extra

BigStringsToBigints<{ }> & object

Returns

any

customizers.welcomeScreen?

optional welcomeScreen?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordWelcomeScreen

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.widget?

optional widget?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordGuildWidget

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

customizers.widgetSettings?

optional widgetSettings?: (bot, payload, transformed, extra?) => any

Parameters

bot

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

payload

DiscordGuildWidgetSettings

transformed

SetupDesiredProps<TTransformed, TProps, TBehavior>

extra?

BigStringsToBigints<{ }>

Returns

any

defaultReactionEmoji?

optional defaultReactionEmoji?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordDefaultReactionEmoji

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

embed?

optional embed?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordEmbed

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

emoji?

optional emoji?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordEmoji

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

entitlement?

optional entitlement?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordEntitlement

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

forumTag?

optional forumTag?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordForumTag

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

gatewayBot?

optional gatewayBot?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGetGatewayBot

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

guild?

optional guild?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuild

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

guildOnboarding?

optional guildOnboarding?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuildOnboarding

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

guildOnboardingPrompt?

optional guildOnboardingPrompt?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuildOnboardingPrompt

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

guildOnboardingPromptOption?

optional guildOnboardingPromptOption?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuildOnboardingPromptOption

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

incidentsData?

optional incidentsData?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordIncidentsData

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

integration?

optional integration?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordIntegrationCreateUpdate

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

interaction?

optional interaction?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInteraction

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

interactionCallback?

optional interactionCallback?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInteractionCallback

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

interactionCallbackResponse?

optional interactionCallbackResponse?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInteractionCallbackResponse

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

interactionDataOptions?

optional interactionDataOptions?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInteractionDataOption

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

interactionDataResolved?

optional interactionDataResolved?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInteractionDataResolved

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

interactionResource?

optional interactionResource?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInteractionResource

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

invite?

optional invite?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInviteMetadata

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

inviteStageInstance?

optional inviteStageInstance?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordInviteStageInstance

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

lobby?

optional lobby?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordLobby

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

lobbyInvite?

optional lobbyInvite?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordLobbyInvite

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

lobbyMember?

optional lobbyMember?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordLobbyMember

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

lobbyMessage?

optional lobbyMessage?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordLobbyMessage

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

mediaGalleryItem?

optional mediaGalleryItem?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMediaGalleryItem

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

member?

optional member?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMember

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

message?

optional message?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMessage

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

messageCall?

optional messageCall?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMessageCall

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

messageInteractionMetadata?

optional messageInteractionMetadata?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMessageInteractionMetadata

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<DiscordMessageInteractionMetadata>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

messagePin?

optional messagePin?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMessagePin

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

messageSnapshot?

optional messageSnapshot?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordMessageSnapshot

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

nameplate?

optional nameplate?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordNameplate

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

poll?

optional poll?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordPoll

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

pollMedia?

optional pollMedia?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordPollMedia

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

presence?

optional presence?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordPresenceUpdate

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

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?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordRole

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

roleColors?

optional roleColors?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordRoleColors

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

scheduledEvent?

optional scheduledEvent?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordScheduledEvent

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

scheduledEventRecurrenceRule?

optional scheduledEventRecurrenceRule?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordScheduledEventRecurrenceRule

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

sharedClientTheme?

optional sharedClientTheme?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordSharedClientTheme

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

sku?

optional sku?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordSku

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

snowflake?

optional snowflake?: (snowflake) => bigint

Parameters

snowflake

BigString

Returns

bigint

soundboardSound?

optional soundboardSound?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordSoundboardSound

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

stageInstance?

optional stageInstance?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordStageInstance

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

sticker?

optional sticker?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordSticker

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

stickerPack?

optional stickerPack?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordStickerPack

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

subscription?

optional subscription?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordSubscription

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

team?

optional team?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordTeam

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

template?

optional template?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordTemplate

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

threadMember?

optional threadMember?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordThreadMember

extra?

ThreadMemberTransformerExtra

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

threadMemberGuildCreate?

optional threadMemberGuildCreate?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordThreadMemberGuildCreate

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

unfurledMediaItem?

optional unfurledMediaItem?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordUnfurledMediaItem

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

user?

optional user?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordUser

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

userPrimaryGuild?

optional userPrimaryGuild?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordUserPrimaryGuild

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

voiceRegion?

optional voiceRegion?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordVoiceRegion

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

voiceState?

optional voiceState?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordVoiceState

extra?

object & object

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

object & object

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

webhook?

optional webhook?: {(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>; (bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>; }

Call Signature

(bot, payload, extra?): SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordWebhook

extra?

partial?

false

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

Call Signature

(bot, payload, extra): Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

Parameters

bot

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

payload

Partial<TPayload>

extra

partial

true

Returns

Partial<SetupDesiredProps<TTransformed, TProps, TBehavior>>

welcomeScreen?

optional welcomeScreen?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordWelcomeScreen

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

widget?

optional widget?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuildWidget

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>

widgetSettings?

optional widgetSettings?: (bot, payload, extra?) => SetupDesiredProps<TTransformed, TProps, TBehavior>

Parameters

bot

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

payload

DiscordGuildWidgetSettings

extra?

Returns

SetupDesiredProps<TTransformed, TProps, TBehavior>