Interface Emitter<Events, Available>

A wrapper for the EventTarget interface that provides the ability to provide known event name/types

interface Emitter<
    Events extends EventsMap,
    Available extends AvailableEvents<Events> = AvailableEvents<Events>,
> {
    emit(event: Available[keyof Available]): this;
    off<const Type extends string>(
        type: Type,
        handler: (event: Available[Type]) => void | Promise<void>,
    ): this;
    on<const Type extends string>(
        type: Type,
        handler: (event: Available[Type]) => void | Promise<void>,
    ): this;
    once<const Type extends string>(
        type: Type,
        handler: (event: Available[Type]) => void | Promise<void>,
    ): this;
    set(
        handlers: Partial<
            {
                [Key in string
                | number
                | symbol]: (event: Available[Key]) => void | Promise<void>
            },
        >,
    ): this;
}

Type Parameters

Events extends EventsMap
Available extends AvailableEvents<Events> = AvailableEvents<Events>

Index

Methods

emit off on once set

Methods

emit

emit(event: Available[keyof Available]): this
Emits a new event of the given type to all attached listeners
Parameters
- event: Available[keyof Available]
Returns this

off

off<const Type extends string>(
type: Type,
handler: (event: Available[Type]) => void | Promise<void>,
): this
Add a new event listener for the given event type
Type Parameters
- const Type extends string
Parameters
- type: Type
- handler: (event: Available[Type]) => void | Promise<void>
Returns this

on

on<const Type extends string>(
type: Type,
handler: (event: Available[Type]) => void | Promise<void>,
): this
Add a new event listener for the given event type
Type Parameters
- const Type extends string
Parameters
- type: Type
- handler: (event: Available[Type]) => void | Promise<void>
Returns this

once

once<const Type extends string>(
type: Type,
handler: (event: Available[Type]) => void | Promise<void>,
): this
Add a new event listener for the given event type that only executes once
Type Parameters
- const Type extends string
Parameters
- type: Type
- handler: (event: Available[Type]) => void | Promise<void>
Returns this

set

set(
    handlers: Partial<
        {
            [Key in string
            | number
            | symbol]: (event: Available[Key]) => void | Promise<void>
        },
    >,
): this
Set multiple event listeners at once through a single object
Parameters
- handlers: Partial<
      {
          [Key in string
          | number
          | symbol]: (event: Available[Key]) => void | Promise<void>
      },
  >
Returns this

Interface Emitter<Events, Available>

Type Parameters

Index

Methods

Methods

emit

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

set

Parameters

Returns this

Settings

On This Page