Interface FilterModule

Defines a module whose {@link filter()} method is used to manipulate or filter out messages as they arrive.

since: 2.0.0

Hierarchy

Module
- FilterModule

Implemented by

AbstractFilterModule

Index

Methods

Methods

filter

filter(msg: Message): Promise<Message | void>

- Defined in api/modules/FilterModule.ts:20
Gets passed a message, optionally executes actions upon it, and returns a message. The filter chain can be broken by returning an empty fulfilled promise.

abstract

since

2.0.0

Parameters
- msg: Message
  
  The received message object.
Returns Promise<Message | void>

The resulting message or an empty promise.

getRuntime

getRuntime(): ModuleAwareRuntime

Inherited from Module.getRuntime
- Defined in api/modules/Module.ts:14
Returns a runtime object corresponding to the current module.

since

2.0.0

Returns ModuleAwareRuntime

onListen

onListen(): Promise<any>

Inherited from Module.onListen
- Defined in api/modules/Module.ts:21
Gets called when the bot starts listening.

since

2.0.0

Returns Promise<any>

onShutdown

onShutdown(): Promise<any>

Inherited from Module.onShutdown
- Defined in api/modules/Module.ts:28
Gets called when the bot is shutting down.

since

2.0.0

Returns Promise<any>

Generated using TypeDoc