Engine | discordquery

discordquery engine class

Hierarchy

Engine

Index

Constructors

constructor

Properties

Constructors

constructor

new Engine(discordToken?: undefined | string): Engine

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:46
Create Engine

Parameters
- Optional discordToken: undefined | string
  
  discord bot token
Returns Engine

Properties

client

client: Client

The Discord.Client instance used with the engine

Optional discordToken

discordToken: undefined | string

The discord bot token to use with the client

instance

instance: EngineInstance

The EngineInstance containing context variables

stack

stack: Array<EngineCall> = []

Internal callstack for executeStack

Methods

deleteMessage

deleteMessage(messageID: string): Promise<SerialMessage>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:250
Delete a message in Engine#instance.currentChannel

Parameters
- messageID: string
  
  discord message id of the existing message to delete
Returns Promise<SerialMessage>

deleteMessages

deleteMessages(options: ChannelLogsQueryOptions): Promise<Array<SerialMessage>>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:260
Delete multiple messages at once in Engine#instance.currentChannel

Parameters
- options: ChannelLogsQueryOptions
  
  ChannelLogsQueryOptions that determines what messages to delete
Returns Promise<Array<SerialMessage>>

editMessage

editMessage(options: EngineEditOptions): Promise<SerialMessage>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:240
Edit an existing message in Engine#instance.currentChannel

Parameters
- options: EngineEditOptions
  
  EngineEditOptions which specifices the message to edit and the new message
Returns Promise<SerialMessage>

execute

execute<K>(command: K, ...args: EngineCommand[K]): Promise<any>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:97
Execute any command from EngineCommand and ensure Engine#Client is connected beforehand

Type parameters
- K: keyof EngineCommand
Parameters
- command: K
  
  EngineCommand command
- Rest ...args: EngineCommand[K]
  
  Arguments needed by the command
Returns Promise<any>

executeStack

executeStack(callback: (command: keyof EngineCommand, value: any) => void): Promise<void>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:84
Run over Engine#stack and execute each command

Parameters
- callback: (command: keyof EngineCommand, value: any) => void
  
  handle all command returns (values)
  - - (command: keyof EngineCommand, value: any): void
    - Parameters
      - command: keyof EngineCommand
      - value: any
      Returns void
Returns Promise<void>

fetchChannel

fetchChannel(channelID: string): Promise<SerialChannel | undefined>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:160
Get Discord.Channel by id

Parameters
- channelID: string
  
  discord channel id to fetch
Returns Promise<SerialChannel | undefined>

fetchGuild

fetchGuild(guildID: string): Promise<SerialGuild | undefined>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:150
Get Discord.Guild by id

Parameters
- guildID: string
  
  discord guild id to fetch
Returns Promise<SerialGuild | undefined>

fetchMember

fetchMember(userID: string): Promise<SerialMember | undefined>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:180
Get Discord.GuildMember by id

Parameters
- userID: string
  
  discord user id to fetch
Returns Promise<SerialMember | undefined>

fetchUser

fetchUser(userID: string): Promise<SerialUser | undefined>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:170
Get Discord.User by id

Parameters
- userID: string
  
  discord user id to fetch
Returns Promise<SerialUser | undefined>

listenChannel

listenChannel(options: EngineListenOptions): Promise<void>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:298
Listen to all Engine#instance.currentChannel events

Parameters
- options: EngineListenOptions
  
  EngineListenOptions object used to handle and filter incomming discord events
Returns Promise<void>

listenClient

listenClient(options: EngineListenOptions): Promise<void>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:280
Listen to all Engine#client events

Parameters
- options: EngineListenOptions
  
  EngineListenOptions object used to handle and filter incomming discord events
Returns Promise<void>

listenGuild

listenGuild(options: EngineListenOptions): Promise<void>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:289
Listen to all Engine#instance.currentGuild events

Parameters
- options: EngineListenOptions
  
  EngineListenOptions object used to handle and filter incomming discord events
Returns Promise<void>

login

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:59
Initializes discord instance

Parameters
- Optional discordToken: undefined | string
Returns Promise<void>

pushStack

pushStack<K>(command: K, args: EngineCommand[K]): void

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:73
Add a call to Engine#stack

Type parameters
- K: keyof EngineCommand
Parameters
- command: K
  
  EngineCommand command
- args: EngineCommand[K]
  
  Arguments needed by the command
Returns void

readChannel

readChannel(options: ChannelLogsQueryOptions): Promise<Array<SerialMessage>>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:270
Get a list of messages in Engine#instance.currentChannel

Parameters
- options: ChannelLogsQueryOptions
  
  ChannelLogsQueryOptions that determines what messages to fetch
Returns Promise<Array<SerialMessage>>

selectChannel

selectChannel(channelID: string): Promise<void>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:141
Set channel in Engine#instance

Parameters
- channelID: string
  
  discord channel id to select
Returns Promise<void>

selectGuild

selectGuild(guildID: string): Promise<void>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:132
Set guild in Engine#instance

Parameters
- guildID: string
  
  discord guild id to select
Returns Promise<void>

sendMessage

sendMessage(options: MessageOptions): Promise<SerialMessage>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:230
Send a message in Engine#instance.currentChannel

Parameters
- options: MessageOptions
  
  MessageOptions object that defines the discord message
Returns Promise<SerialMessage>

showChannels

showChannels(search?: undefined | string): Promise<Array<SerialChannel>>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:200
Get a list of channels Engine#instance.currentGuild has

Parameters
- Optional search: undefined | string
  
  string to match name of the channels
Returns Promise<Array<SerialChannel>>

showGuilds

showGuilds(search?: undefined | string): Promise<Array<SerialGuild>>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:190
Get a list of guilds Engine#client exists in

Parameters
- Optional search: undefined | string
  
  string to match name of the guilds
Returns Promise<Array<SerialGuild>>

showMembers

showMembers(search?: undefined | string): Promise<Array<SerialMember>>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:210
Get a list of members Engine#instance.currentGuild has

Parameters
- Optional search: undefined | string
  
  string to match name of the username#0000
Returns Promise<Array<SerialMember>>

updatePrecense

updatePrecense(newPresence: PresenceData): Promise<SerialPresence | undefined>

- Defined in Users/javad/Dropbox/udvikling/projekter/discord-cli/src/engine/index.ts:221
Update Engine#client (bot instance) discord presence

Parameters
- newPresence: PresenceData
  
  new overwriting precense
Returns Promise<SerialPresence | undefined>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional discordToken: undefined | string

Returns Engine

Properties

client

Optional discordToken

instance

stack

Methods

deleteMessage

Parameters

messageID: string

Returns Promise<SerialMessage>

deleteMessages

Parameters

options: ChannelLogsQueryOptions

Returns Promise<Array<SerialMessage>>

editMessage

Parameters

options: EngineEditOptions

Returns Promise<SerialMessage>

execute

Type parameters

K: keyof EngineCommand

Parameters

command: K

Rest ...args: EngineCommand[K]

Returns Promise<any>

executeStack

Parameters

callback: (command: keyof EngineCommand, value: any) => void

Parameters

command: keyof EngineCommand

value: any

Returns void

Returns Promise<void>

fetchChannel

Parameters

channelID: string

Returns Promise<SerialChannel | undefined>

fetchGuild

Parameters

guildID: string

Returns Promise<SerialGuild | undefined>

fetchMember

Parameters

userID: string

Returns Promise<SerialMember | undefined>

fetchUser

Parameters

userID: string

Returns Promise<SerialUser | undefined>

listenChannel

Parameters

options: EngineListenOptions

Returns Promise<void>

listenClient

Parameters

options: EngineListenOptions

Returns Promise<void>

listenGuild

Parameters

options: EngineListenOptions

Returns Promise<void>

login

Parameters

Optional discordToken: undefined | string

Returns Promise<void>

pushStack

Type parameters

K: keyof EngineCommand

Parameters

command: K