Class ListenerHandler

Loads listeners and registers them with EventEmitters.

Hierarchy (View Summary)

AkairoHandler<Listener, ListenerHandler, ListenerHandlerEvents>
- ListenerHandler

Constructors

constructor

new ListenerHandler(
client: AkairoClient,
options: ListenerHandlerOptions,
): ListenerHandler
Parameters
- client: AkairoClient
  The Akairo client.
- options: ListenerHandlerOptions
  Options.
Returns ListenerHandler
Overrides AkairoHandler.constructor
- Defined in src/struct/listeners/ListenerHandler.ts:24

Properties

`Protected` `Readonly`[brandSymbol]

"[brandSymbol]": ListenerHandlerEvents

This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

automateCategories

automateCategories: boolean

Whether or not to automate category names.

classToHandle

classToHandle: Class<Listener>

Class to handle.

client

client: AkairoClient

The Akairo client.

emitters

emitters: Collection<string, EventEmitter<DefaultEventMap>>

EventEmitters for use, mapped by name to EventEmitter. By default, 'client' is set to the given client.

extensions

extensions: Set<string>

File extensions to load.

loadFilter

loadFilter: LoadPredicate

Function that filters files when loading.

modules

modules: Collection<string, Listener>

Modules loaded, mapped by ID to AkairoModule.

Methods

addListener

addListener<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18

addToEmitter

addToEmitter(id: string): Listener
Adds a listener to the EventEmitter.
Parameters
- id: string
  ID of the listener.
Returns Listener
- Defined in src/struct/listeners/ListenerHandler.ts:41

deregister

deregister(listener: Listener): void
Deregisters a listener.
Parameters
- listener: Listener
  Listener to use.
Returns void
Overrides AkairoHandler.deregister
- Defined in src/struct/listeners/ListenerHandler.ts:56

emit

emit<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<ListenerHandlerEvents>,
        K,
    >,
): boolean
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<
  AsyncEventEmitter<ListenerHandlerEvents>,
  K,
  >
Returns boolean
Inherited from AkairoHandler.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:37
emit<K extends string | symbol>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<ListenerHandlerEvents>,
        K,
    >,
): boolean
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<
  AsyncEventEmitter<ListenerHandlerEvents>,
  K,
  >
Returns boolean
Inherited from AkairoHandler.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38

eventNames

eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof ListenerHandlerEvents
)[]
Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof ListenerHandlerEvents
)[]
Inherited from AkairoHandler.eventNames
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:45

findCategory

findCategory(name: string): undefined | Category<string, Listener>
Finds a category by name.
Parameters
- name: string
  Name to find with.
Returns undefined | Category<string, Listener>
Inherited from AkairoHandler.findCategory
- Defined in src/struct/AkairoHandler.ts:114

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from AkairoHandler.getMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32

listenerCount

listenerCount<K extends "remove" | "load" | "removeListener" | "newListener">(
eventName: K,
): number
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
Returns number
Inherited from AkairoHandler.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName: string | symbol): number
Parameters
- eventName: string | symbol
Returns number
Inherited from AkairoHandler.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40

listeners

listeners<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ListenerHandlerEvents>,
        K,
        ListenerHandlerEvents,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ListenerHandlerEvents>,
        K,
        ListenerHandlerEvents,
    >["listener"],
    undefined,
>[]
Inherited from AkairoHandler.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners<K extends string | symbol>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ListenerHandlerEvents>,
        K,
        ListenerHandlerEvents,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ListenerHandlerEvents>,
        K,
        ListenerHandlerEvents,
    >["listener"],
    undefined,
>[]
Inherited from AkairoHandler.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34

load

load(
thing: string | Listener,
isReload?: boolean,
): Promise<undefined | Listener>
Loads a module, can be a module class or a filepath.
Parameters
- thing: string | Listener
  Module class or path to module.
- isReload: boolean = false
  Whether this is a reload or not.
Returns Promise<undefined | Listener>
Inherited from AkairoHandler.load
- Defined in src/struct/AkairoHandler.ts:125

loadAll

loadAll(directory?: string, filter?: LoadPredicate): Promise<ListenerHandler>
Reads all modules from a directory and loads them.
Parameters
- directory: string = ...
  Directory to load from. Defaults to the directory passed in the constructor.
- filter: LoadPredicate = ...
  Filter for files, where true means it should be loaded. Defaults to the filter passed in the constructor.
Returns Promise<ListenerHandler>
Inherited from AkairoHandler.loadAll
- Defined in src/struct/AkairoHandler.ts:199

off

off<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25
off<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:26

on

on<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19
on<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20

once

once<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21
once<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22

prependListener

prependListener<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:41
prependListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:42

prependOnceListener

prependOnceListener<
    K extends "remove"
    | "load"
    | "removeListener"
    | "newListener",
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:43
prependOnceListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44

rawListeners

rawListeners<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ListenerHandlerEvents>,
    K,
    ListenerHandlerEvents,
>[]
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ListenerHandlerEvents>,
    K,
    ListenerHandlerEvents,
>[]
Inherited from AkairoHandler.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners<K extends string | symbol>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ListenerHandlerEvents>,
    K,
    ListenerHandlerEvents,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ListenerHandlerEvents>,
    K,
    ListenerHandlerEvents,
>[]
Inherited from AkairoHandler.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36

register

register(listener: Listener, filepath: null | string): void
Registers a listener.
Parameters
- listener: Listener
  Listener to use.
- filepath: null | string
  Filepath of listener.
Returns void
Overrides AkairoHandler.register
- Defined in src/struct/listeners/ListenerHandler.ts:66

reload

reload(id: string): Promise<undefined | Listener>
Reloads a module.
Parameters
- id: string
  ID of the module.
Returns Promise<undefined | Listener>
Inherited from AkairoHandler.reload
- Defined in src/struct/AkairoHandler.ts:243

reloadAll

reloadAll(): Promise<ListenerHandler>
Reloads all modules.

Returns Promise<ListenerHandler>
Inherited from AkairoHandler.reloadAll
- Defined in src/struct/AkairoHandler.ts:258

remove

remove(id: string): Listener
Removes a module.
Parameters
- id: string
  ID of the module.
Returns Listener
Inherited from AkairoHandler.remove
- Defined in src/struct/AkairoHandler.ts:272

removeAll

removeAll(): this
Removes all modules.

Returns this
Inherited from AkairoHandler.removeAll
- Defined in src/struct/AkairoHandler.ts:286

removeAllListeners

removeAllListeners<
    K extends "remove"
    | "load"
    | "removeListener"
    | "newListener",
>(
    event: K,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- event: K
Returns this
Inherited from AkairoHandler.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners<
    K extends "remove"
    | "load"
    | "removeListener"
    | "newListener",
>(
    event?: K,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- Optionalevent: K
Returns this
Inherited from AkairoHandler.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event: string | symbol): this
Parameters
- event: string | symbol
Returns this
Inherited from AkairoHandler.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event?: string | symbol): this
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from AkairoHandler.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:30

removeFromEmitter

removeFromEmitter(id: string): Listener
Removes a listener from the EventEmitter.
Parameters
- id: string
  ID of the listener.
Returns Listener
- Defined in src/struct/listeners/ListenerHandler.ts:76

removeListener

removeListener<K extends "remove" | "load" | "removeListener" | "newListener">(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends "remove" | "load" | "removeListener" | "newListener"
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ListenerHandlerEvents>,
            K,
            ListenerHandlerEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ListenerHandlerEvents>,
          K,
          ListenerHandlerEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AkairoHandler.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24

setEmitters

setEmitters(emitters: any): ListenerHandler
Sets custom emitters.
Parameters
- emitters: any
  Emitters to use. The key is the name and value is the emitter.
Returns ListenerHandler
- Defined in src/struct/listeners/ListenerHandler.ts:93

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from AkairoHandler.setMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31

waitForAllListenersToComplete

waitForAllListenersToComplete(): Promise<boolean>
Returns Promise<boolean>
Inherited from AkairoHandler.waitForAllListenersToComplete
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:46

`Static`listenerCount

listenerCount<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
): number
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName
Returns number
Inherited from AkairoHandler.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(
emitter: AsyncEventEmitter<any>,
eventName: string | symbol,
): number
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
Returns number
Inherited from AkairoHandler.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:50

`Static`on

on<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Inherited from AkairoHandler.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:53
on(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): AsyncGenerator<any[], void>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<any[], void>
Inherited from AkairoHandler.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:54

`Static`once

once<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Inherited from AkairoHandler.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:51
once(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): Promise<any[]>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns Promise<any[]>
Inherited from AkairoHandler.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:52

`Static`readdirRecursive

readdirRecursive(directory: string): string[]
Reads files recursively from a directory.
Parameters
- directory: string
  Directory to read.
Returns string[]
Inherited from AkairoHandler.readdirRecursive
- Defined in src/struct/AkairoHandler.ts:298

Class ListenerHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ListenerHandler

Properties

Protected Readonly[brandSymbol]

automateCategories

categories

classToHandle

client

directory

emitters

extensions

loadFilter

modules

Methods

addListener

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

addToEmitter

Parameters

Returns Listener

deregister

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & ( keyof ListenerHandlerEvents)[]

findCategory

Parameters

Returns undefined | Category<string, Listener>

getMaxListeners

Returns number

listenerCount

Type Parameters

Parameters

Returns number

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Exclude< InternalAsyncEventEmitterInternalListenerForEvent< AsyncEventEmitter<ListenerHandlerEvents>, K, ListenerHandlerEvents, >["listener"], undefined,>[]

Type Parameters

Parameters

Returns Exclude< InternalAsyncEventEmitterInternalListenerForEvent< AsyncEventEmitter<ListenerHandlerEvents>, K, ListenerHandlerEvents, >["listener"], undefined,>[]

load

Parameters

Returns Promise<undefined | Listener>

loadAll

Parameters

Returns Promise<ListenerHandler>

off

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

Type Parameters

`Protected` `Readonly`[brandSymbol]

Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof ListenerHandlerEvents
)[]

Returns Exclude<
InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ListenerHandlerEvents>,
K,
ListenerHandlerEvents,
>["listener"],
undefined,
>[]

Returns Exclude<
InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ListenerHandlerEvents>,
K,
ListenerHandlerEvents,
>["listener"],
undefined,
>[]

Returns InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ListenerHandlerEvents>,
K,
ListenerHandlerEvents,
>[]

Returns InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ListenerHandlerEvents>,
K,
ListenerHandlerEvents,
>[]