Transformers

Properties

raw?

optional raw: object

return

return: TransformerReturnType

handler()

handler: (data) => unknown

Parameters

Parameter	Type
data	ReceiveDispatchEvent

Returns

unknown

Defined in

typings/client.ts:96

---

ready?

optional ready: Transformer<object>

Type declaration

v

v: number

user

user: Structure

guilds

guilds: UnavailableStructure[]

session_id

session_id: string

resume_gateway_url

resume_gateway_url: string

shard?

optional shard: [number, number]

application

application: Partial<Structure>

Defined in

typings/client.ts:100

---

resumed?

optional resumed: Transformer<undefined>

Defined in

typings/client.ts:101

---

applicationCommandPermissionsUpdate?

optional applicationCommandPermissionsUpdate: Transformer<PermissionsStructure>

Defined in

typings/client.ts:102

---

autoModerationRuleCreate?

optional autoModerationRuleCreate: Transformer<RuleStructure>

Defined in

typings/client.ts:103

---

autoModerationRuleUpdate?

optional autoModerationRuleUpdate: Transformer<RuleStructure>

Defined in

typings/client.ts:104

---

autoModerationRuleDelete?

optional autoModerationRuleDelete: Transformer<RuleStructure>

Defined in

typings/client.ts:105

---

autoModerationActionExecution?

optional autoModerationActionExecution: Transformer<object>

Type declaration

guild_id

guild_id: string

action

action: ActionStructure

rule_id

rule_id: string

rule_trigger_type

rule_trigger_type: AutoModerationTriggerType

user_id

user_id: string

channel_id?

optional channel_id: string

message_id?

optional message_id: string

alert_system_message_id?

optional alert_system_message_id: string

content

content: string

matched_keyword

matched_keyword: null | string

matched_content

matched_content: null | string

Defined in

typings/client.ts:106

---

channelCreate?

optional channelCreate: Transformer<Structure>

Defined in

typings/client.ts:107

---

channelUpdate?

optional channelUpdate: Transformer<Structure>

Defined in

typings/client.ts:108

---

channelDelete?

optional channelDelete: Transformer<Structure>

Defined in

typings/client.ts:109

---

channelPinsUpdate?

optional channelPinsUpdate: Transformer<object>

Type declaration

guild_id?

optional guild_id: string

channel_id

channel_id: string

last_pin_timestamp?

optional last_pin_timestamp: null | string

ISO8601 Timestamp

Defined in

typings/client.ts:110

---

threadCreate?

optional threadCreate: Transformer<Structure & object>

Defined in

typings/client.ts:111

---

threadUpdate?

optional threadUpdate: Transformer<Structure>

Defined in

typings/client.ts:112

---

threadDelete?

optional threadDelete: Transformer<Pick<ThreadChannelStructure, "id" | "type" | "guild_id" | "parent_id">>

Defined in

typings/client.ts:113

---

threadListSync?

optional threadListSync: Transformer<object>

Type declaration

guild_id

guild_id: string

channel_ids?

optional channel_ids: string[]

threads

threads: Structure[]

members

members: ThreadMemberStructure[]

Defined in

typings/client.ts:114

---

threadMemberUpdate?

optional threadMemberUpdate: Transformer<ThreadMemberStructure & object>

Defined in

typings/client.ts:115

---

threadMembersUpdate?

optional threadMembersUpdate: Transformer<object>

Type declaration

id

id: string

guild_id

guild_id: string

member_count

member_count: number

added_members?

optional added_members: ThreadMemberStructure & MemberStructure & PresenceUpdateEventFields[]

removed_member_ids?

optional removed_member_ids: string[]

Defined in

typings/client.ts:116

---

guildCreate?

optional guildCreate: Transformer<UnavailableStructure | New>

Defined in

typings/client.ts:117

---

guildUpdate?

optional guildUpdate: Transformer<Structure>

Defined in

typings/client.ts:118

---

guildDelete?

optional guildDelete: Transformer<UnavailableStructure>

Defined in

typings/client.ts:119

---

guildAuditLogEntryCreate?

optional guildAuditLogEntryCreate: Transformer<EntryStructure>

Defined in

typings/client.ts:120

---

guildBanAdd?

optional guildBanAdd: Transformer<object>

Type declaration

guild_id

guild_id: string

user

user: Structure

Defined in

typings/client.ts:121

---

guildBanRemove?

optional guildBanRemove: Transformer<object>

Type declaration

guild_id

guild_id: string

user

user: Structure

Defined in

typings/client.ts:122

---

guildEmojisUpdate?

optional guildEmojisUpdate: Transformer<object>

Type declaration

guild_id

guild_id: string

emojis

emojis: Structure[]

Defined in

typings/client.ts:123

---

guildStickersUpdate?

optional guildStickersUpdate: Transformer<object>

Type declaration

guild_id

guild_id: string

stickers

stickers: Structure[]

Defined in

typings/client.ts:124

---

guildIntegrationsUpdate?

optional guildIntegrationsUpdate: Transformer<object>

Type declaration

guild_id

guild_id: string

Defined in

typings/client.ts:125

---

guildMemberAdd?

optional guildMemberAdd: Transformer<MemberStructure & object>

Defined in

typings/client.ts:126

---

guildMemberRemove?

optional guildMemberRemove: Transformer<object>

Type declaration

guild_id

guild_id: string

user

user: Structure

Defined in

typings/client.ts:127

---

guildMemberUpdate?

optional guildMemberUpdate: Transformer<object>

Type declaration

guild_id

guild_id: string

roles

roles: string[]

user

user: Structure

nick?

optional nick: null | string

avatar

avatar: null | string

joined_at

joined_at: null | string

ISO8601 Timestamp

premium_since?

optional premium_since: null | string

ISO8601 Timestamp

deaf?

optional deaf: boolean

mute?

optional mute: boolean

pending?

optional pending: boolean

communication_disabled_until?

optional communication_disabled_until: null | string

ISO8601 Timestamp

Defined in

typings/client.ts:128

---

guildMembersChunk?

optional guildMembersChunk: Transformer<object>

Type declaration

guild_id

guild_id: string

members

members: MemberStructure[]

chunk_index

chunk_index: number

chunk_count

chunk_count: number

not_found?

optional not_found: string[]

presences?

optional presences: PresenceUpdateEventFields[]

nonce?

optional nonce: string

Defined in

typings/client.ts:129

---

guildRoleCreate?

optional guildRoleCreate: Transformer<object>

Type declaration

guild_id

guild_id: string

role

role: Structure

Defined in

typings/client.ts:130

---

guildRoleUpdate?

optional guildRoleUpdate: Transformer<object>

Type declaration

guild_id

guild_id: string

role

role: Structure

Defined in

typings/client.ts:131

---

guildRoleDelete?

optional guildRoleDelete: Transformer<object>

Type declaration

guild_id

guild_id: string

role_id

role_id: string

Defined in

typings/client.ts:132

---

guildScheduledEventCreate?

optional guildScheduledEventCreate: Transformer<ScheduledEventStructure>

Defined in

typings/client.ts:133

---

guildScheduledEventUpdate?

optional guildScheduledEventUpdate: Transformer<ScheduledEventStructure>

Defined in

typings/client.ts:134

---

guildScheduledEventDelete?

optional guildScheduledEventDelete: Transformer<ScheduledEventStructure>

Defined in

typings/client.ts:135

---

guildScheduledEventUserAdd?

optional guildScheduledEventUserAdd: Transformer<object>

Type declaration

guild_scheduled_event_id

guild_scheduled_event_id: string

user_id

user_id: string

guild_id

guild_id: string

Defined in

typings/client.ts:136

---

guildScheduledEventUserRemove?

optional guildScheduledEventUserRemove: Transformer<object>

Type declaration

guild_scheduled_event_id

guild_scheduled_event_id: string

user_id

user_id: string

guild_id

guild_id: string

Defined in

typings/client.ts:137

---

integrationCreate?

optional integrationCreate: Transformer<IntegrationStructure & object>

Defined in

typings/client.ts:138

---

integrationUpdate?

optional integrationUpdate: Transformer<IntegrationStructure & object>

Defined in

typings/client.ts:139

---

integrationDelete?

optional integrationDelete: Transformer<object>

Type declaration

id

id: string

guild_id

guild_id: string

application_id?

optional application_id: string

Defined in

typings/client.ts:140

---

interactionCreate?

optional interactionCreate: Transformer<Structure>

Defined in

typings/client.ts:141

---

inviteCreate?

optional inviteCreate: Transformer<object>

Type declaration

channel_id

channel_id: string

code

code: string

created_at

created_at: string

ISO8601 Timestamp

guild_id?

optional guild_id: string

inviter?

optional inviter: Structure

max_age

max_age: number

max_uses

max_uses: number

target_type?

optional target_type: InviteTargetType

target_user?

optional target_user: Structure

target_application?

optional target_application: Partial<Structure>

temporary

temporary: boolean

uses

uses: number

Defined in

typings/client.ts:142

---

inviteDelete?

optional inviteDelete: Transformer<object>

Type declaration

channel_id

channel_id: string

guild_id?

optional guild_id: string

code

code: string

Defined in

typings/client.ts:143

---

messageCreate?

optional messageCreate: Transformer<GuildStructure>

Defined in

typings/client.ts:144

---

messageUpdate?

optional messageUpdate: Transformer<Partial<GuildStructure>>

Defined in

typings/client.ts:145

---

messageDelete?

optional messageDelete: Transformer<object>

Type declaration

id

id: string

channel_id

channel_id: string

guild_id?

optional guild_id: string

Defined in

typings/client.ts:146

---

messageDeleteBulk?

optional messageDeleteBulk: Transformer<object>

Type declaration

ids

ids: string[]

channel_id

channel_id: string

guild_id?

optional guild_id: string

Defined in

typings/client.ts:147

---

messageReactionAdd?

optional messageReactionAdd: Transformer<object>

Type declaration

user_id

user_id: string

channel_id

channel_id: string

message_id

message_id: string

guild_id?

optional guild_id: string

member?

optional member: MemberStructure

emoji

emoji: Partial<Structure>

message_author_id?

optional message_author_id: string

Defined in

typings/client.ts:148

---

messageReactionRemove?

optional messageReactionRemove: Transformer<object>

Type declaration

user_id

user_id: string

channel_id

channel_id: string

message_id

message_id: string

guild_id?

optional guild_id: string

emoji

emoji: Partial<Structure>

Defined in

typings/client.ts:149

---

messageReactionRemoveAll?

optional messageReactionRemoveAll: Transformer<object>

Type declaration

channel_id

channel_id: string

message_id

message_id: string

guild_id?

optional guild_id: string

Defined in

typings/client.ts:150

---

messageReactionRemoveEmoji?

optional messageReactionRemoveEmoji: Transformer<object>

Type declaration

channel_id

channel_id: string

guild_id?

optional guild_id: string

message_id

message_id: string

emoji

emoji: Partial<Structure>

Defined in

typings/client.ts:151

---

presenceUpdate?

optional presenceUpdate: Transformer<object>

Type declaration

user

user: Partial<Structure> & Pick<Structure, "id">

Only id will always exist

guild_id

guild_id: string

status

status: Status

activities

activities: ActivityStructure[]

client_status

client_status: object

client_status.desktop?

optional desktop: Status

client_status.mobile?

optional mobile: Status

client_status.web?

optional web: Status

Defined in

typings/client.ts:152

---

stageInstanceCreate?

optional stageInstanceCreate: Transformer<Structure>

Defined in

typings/client.ts:153

---

stageInstanceUpdate?

optional stageInstanceUpdate: Transformer<Structure>

Defined in

typings/client.ts:154

---

stageInstanceDelete?

optional stageInstanceDelete: Transformer<Structure>

Defined in

typings/client.ts:155

---

typingStart?

optional typingStart: Transformer<object>

Type declaration

channel_id

channel_id: string

guild_id?

optional guild_id: string

user_id

user_id: string

timestamp

timestamp: number

member?

optional member: MemberStructure

Defined in

typings/client.ts:156

---

userUpdate?

optional userUpdate: Transformer<Structure>

Defined in

typings/client.ts:157

---

voiceStateUpdate?

optional voiceStateUpdate: Transformer<StateStructure>

Defined in

typings/client.ts:158

---

voiceServerUpdate?

optional voiceServerUpdate: Transformer<object>

Type declaration

token

token: string

guild_id

guild_id: string

endpoint

endpoint: null | string

Defined in

typings/client.ts:159

---

webhookUpdate?

optional webhookUpdate: Transformer<object>

Type declaration

guild_id

guild_id: string

channel_id

channel_id: string

Defined in

typings/client.ts:160

---

messagePollVoteAdd?

optional messagePollVoteAdd: Transformer<GatewayPayload>

Defined in

typings/client.ts:161

---

messagePollVoteRemove?

optional messagePollVoteRemove: Transformer<GatewayPayload>

Defined in

typings/client.ts:162