Serializer | discordquery

Huge class contaning functions to serialize discord.js classes into simple objects

Hierarchy

Serializer

Index

Methods

Static activity

activity(activities: Array<Activity>): Array<SerialActivity>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:311
Serialize an array of discord activity into an array of objects

Parameters
- activities: Array<Activity>
  
  Array of discord activities
Returns Array<SerialActivity>

Static channel

channel(channel: TextChannel | GuildChannel): SerialChannel

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:205
Serialize a single discord channel into its counterpart object

Parameters
- channel: TextChannel | GuildChannel
  
  Discord channel class instance
Returns SerialChannel

Static channels

channels(channels: Array<TextChannel | GuildChannel>): Array<SerialChannel>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:108
Take an array of discord channels and serialize them individually with .channel()

Parameters
- channels: Array<TextChannel | GuildChannel>
  
  Array of discord channels
Returns Array<SerialChannel>

Static emoji

emoji(emoji: Emoji): SerialEmoji

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:244
Serialize a single discord emoji into its counterpart object

Parameters
- emoji: Emoji
  
  Discord emoji class instance
Returns SerialEmoji

Static guild

guild(guild: Guild): SerialGuild

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:223
Serialize a single discord guild into its counterpart object

Parameters
- guild: Guild
  
  Discord guild class instance
Returns SerialGuild

Static guilds

guilds(guilds: Array<Guild>): Array<SerialGuild>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:97
Take an array of discord guilds and serialize them individually with .guild()

Parameters
- guilds: Array<Guild>
  
  Array of discord guilds
Returns Array<SerialGuild>

Static member

member(member: GuildMember): SerialMember

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:182
Serialize a single discord member into its counterpart object

Parameters
- member: GuildMember
  
  Discord member class instance
Returns SerialMember

Static members

members(members: Array<GuildMember>): Array<SerialMember>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:130
Take an array of discord members and serialize them individually with .member()

Parameters
- members: Array<GuildMember>
  
  Array of discord guild members
Returns Array<SerialMember>

Static message

message(message: Message): SerialMessage

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:141
Serialize a single discord message into its counterpart object

Parameters
- message: Message
  
  Discord message class instance
Returns SerialMessage

Static messages

messages(messages: Array<Message>): Array<SerialMessage>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:119
Take an array of discord messages and serialize them individually with .messages()

Parameters
- messages: Array<Message>
  
  Array of discord messages
Returns Array<SerialMessage>

Static normalizeListener

normalizeListener(name: keyof ClientEvents, ...params: any): Array<SerialVoid | SerialMessage | SerialUser | SerialMember | SerialChannel | SerialGuild | SerialEmoji | SerialReaction | SerialRole | SerialPresence | SerialActivity | SerialPermissions | any>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:41
Serialize a discord event into a list of objects

Parameters
- name: keyof ClientEvents
- Rest ...params: any
Returns Array<SerialVoid | SerialMessage | SerialUser | SerialMember | SerialChannel | SerialGuild | SerialEmoji | SerialReaction | SerialRole | SerialPresence | SerialActivity | SerialPermissions | any>

Static normalizeQuery

normalizeQuery(command: keyof EngineCommand, value: any): Array<SerialVoid | SerialMessage | SerialUser | SerialMember | SerialChannel | SerialGuild | SerialEmoji | SerialReaction | SerialRole | SerialPresence | SerialActivity | SerialPermissions>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:12
Serialize a callback from the engine and its value into an object

Parameters
- command: keyof EngineCommand
  
  Engine command
- value: any
  
  The value returned by the engine command
Returns Array<SerialVoid | SerialMessage | SerialUser | SerialMember | SerialChannel | SerialGuild | SerialEmoji | SerialReaction | SerialRole | SerialPresence | SerialActivity | SerialPermissions>

Static permissions

permissions(permissions: Permissions): Array<SerialPermissions>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:338
Serialize a single discord permissions into an array of permission flags

Parameters
- permissions: Permissions
  
  Discord permissions class instance
Returns Array<SerialPermissions>

Static presence

presence(presence: Presence): SerialPresence

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:296
Serialize a single discord presence into its counterpart object

Parameters
- presence: Presence
  
  Discord presence class instance
Returns SerialPresence

Static reaction

reaction(reaction: MessageReaction): SerialReaction

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:258
Serialize a single discord reaction into its counterpart object

Parameters
- reaction: MessageReaction
  
  Discord reaction class instance
Returns SerialReaction

Static role

role(role: Role): SerialRole

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:272
Serialize a single discord role into its counterpart object

Parameters
- role: Role
  
  Discord role class instance
Returns SerialRole

Static user

user(user: User): SerialUser

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:162
Serialize a single discord user into its counterpart object

Parameters
- user: User
  
  Discord user class instance
Returns SerialUser

Static void

void(): SerialVoid

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/controllers/serializer.ts:89
void serializer to sympolize nothing is serialized or exists

Returns SerialVoid

Hierarchy

Index

Methods

Methods

Static activity

Parameters

activities: Array<Activity>

Returns Array<SerialActivity>

Static channel

Parameters

channel: TextChannel | GuildChannel

Returns SerialChannel

Static channels

Parameters

channels: Array<TextChannel | GuildChannel>

Returns Array<SerialChannel>

Static emoji

Parameters

emoji: Emoji

Returns SerialEmoji

Static guild

Parameters

guild: Guild

Returns SerialGuild

Static guilds

Parameters

guilds: Array<Guild>

Returns Array<SerialGuild>

Static member

Parameters

member: GuildMember

Returns SerialMember

Static members

Parameters

members: Array<GuildMember>

Returns Array<SerialMember>

Static message

Parameters

message: Message

Returns SerialMessage

Static messages

Parameters

messages: Array<Message>

Returns Array<SerialMessage>

Static normalizeListener

Parameters

name: keyof ClientEvents

Rest ...params: any

Returns Array<SerialVoid | SerialMessage | SerialUser | SerialMember | SerialChannel | SerialGuild | SerialEmoji | SerialReaction | SerialRole | SerialPresence | SerialActivity | SerialPermissions | any>

Static normalizeQuery

Parameters

command: keyof EngineCommand

value: any

Returns Array<SerialVoid | SerialMessage | SerialUser | SerialMember | SerialChannel | SerialGuild | SerialEmoji | SerialReaction | SerialRole | SerialPresence | SerialActivity | SerialPermissions>

Static permissions

Parameters

permissions: Permissions

Returns Array<SerialPermissions>

Static presence

Parameters

presence: Presence

Returns SerialPresence

Static reaction

Parameters

reaction: MessageReaction

Returns SerialReaction

Static role

Parameters

role: Role

Returns SerialRole

Static user

Parameters

user: User

Returns SerialUser

Static void

Returns SerialVoid