Class Plugin<ConfigType>

Type parameters

ConfigType

Hierarchy

Plugin
- default
- default
- default
- default
- default
- default
- default
- default
- default

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Plugin<ConfigType>(context: DiscordBot, _config?: ConfigType): Plugin<ConfigType>

- Defined in src/typedef/Plugin.ts:9
Type parameters
- ConfigType
Parameters
- context: DiscordBot
- Optional _config: ConfigType
Returns Plugin<ConfigType>

Properties

Protected config

config: ConfigType

Protected context

context: DiscordBot

Private handlers

handlers: {} = {}

Type declaration

Static defaultConfig

defaultConfig: any

Methods

clearHandlers

clearHandlers(): void

- Defined in src/typedef/Plugin.ts:39
Returns void

declareHandler

declareHandler(name: string, handler: (event: CommunicationEvent) => void): void

- Defined in src/typedef/Plugin.ts:32
Parameters
- name: string
- handler: (event: CommunicationEvent) => void
  - - (event: CommunicationEvent): void
    - Parameters
      - event: CommunicationEvent
      Returns void
Returns void

Abstract extract

extract(context: DiscordBot): void

- Defined in src/typedef/Plugin.ts:29
Removes the plugin's hooks from the bot. It's up to the plugin developer to not break anything.

Parameters
- context: DiscordBot
  
  the Discord bot context to remove plugin elements from.
Returns void

Abstract inject

inject(context: DiscordBot): void

- Defined in src/typedef/Plugin.ts:22
Injects the plugin's hooks into the bot. It's up to the plugin developer to not break anything.

Parameters
- context: DiscordBot
  
  the Discord bot context to inject into.
Returns void

Generated using TypeDoc