Class Listener

Hierarchy

AppHandler<Bot>
- Listener

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Listener(): Listener

Overrides AppHandler.constructor
- Defined in src/components/listener.ts:22
Register a listener to one or more listeners.

Returns Listener

Properties

Readonly $identify

$identify: string

What is the app handler called, used to distinguish between different app handlers.

Private default_options

default_options: Partial<Options>

Private event_pool

event_pool: EventPool<Bot, ListenerEventElem<Bot, keyof EventMap<Bot>, any>>

Private option_map

option_map: {}

Type declaration

[hash: string]: Options[keyof Options]

Methods

apphandler

apphandler(app: Bot): void

Overrides AppHandler.apphandler
- Defined in src/components/listener.ts:29
See example:
```
const app = new Bot(...)
const handler = new AppHandler(...)
...
app.use(handler)
```
app.use will call the function apphandler in the class handler.
Parameters
- app: Bot
Returns void

event

event<T>(event_name: T, action: EventResponse<ListenerActionThis<Bot, T>, T>, options?: Partial<Options[T]>): Listener

- Defined in src/components/listener.ts:49
Type Parameters
- T extends keyof EventMap<Bot>
Parameters
- event_name: T
  
  事件名称
- action: EventResponse<ListenerActionThis<Bot, T>, T>
  
  事件执行函数
- Optional options: Partial<Options[T]>
  
  附加选项
Returns Listener

Private option_pass

option_pass<T>(event_name: T, options: Options[T], args: Parameters<EventMap<Bot>[T]>): boolean

- Defined in src/components/listener.ts:66
Type Parameters
- T extends keyof EventMap<Bot>
Parameters
- event_name: T
- options: Options[T]
- args: Parameters<EventMap<Bot>[T]>
Returns boolean

Static Private filterInExclude

filterInExclude(id: string | number, include: undefined | string | number | (string | number)[], exclude: undefined | string | number | (string | number)[]): boolean

- Defined in src/components/listener.ts:107
Parameters
- id: string | number
- include: undefined | string | number | (string | number)[]
- exclude: undefined | string | number | (string | number)[]
Returns boolean

Static Private isEventNameMessage

isEventNameMessage(event_name: keyof EventMap<Bot>): event_name is never

- Defined in src/components/listener.ts:143
Parameters
- event_name: keyof EventMap<Bot>
Returns event_name is never

Static Private mergeOptions

mergeOptions<T>(options: T, patch: Partial<T>): T

- Defined in src/components/listener.ts:134
Type Parameters
- T
Parameters
- options: T
- patch: Partial<T>
Returns T

Generated using TypeDoc