Type Alias Dispatcher<T>

Dispatcher<T>: {
    addListener: ((callback: ListenerCallback<T>) => number);
    emit: T extends undefined
        ? (() => void)
        : ((opts: T) => void);
    removeAllListeners: (() => void);
    removeListener: ((id: number) => void);
}

Simplifies adding event listeners to your code.

Examples

import { newDispatcher } from "./src/blocks/dispatcher";

const dispatcher = newDispatcher();

let count = 0;

dispatcher.addListener(() => { count += 2; });

dispatcher.emit();

console.log(count); // 2

dispatcher.addListener(() => { count += 4; });

dispatcher.emit();

console.log(count); // 8

Typed Options

import { newDispatcher } from "./src/blocks/dispatcher";

const dispatcher = newDispatcher<string>();

dispatcher.addListener((name) => { console.log(`Hello ${name}!`) });

dispatcher.emit("John"); // 'Hello John!'

Type Parameters

  • T = undefined

Type declaration

  • addListener: ((callback: ListenerCallback<T>) => number)

    Adds an event listener

      • (callback): number

      • Parameters

        Returns number

        Usage

        const listenerId = dispatcher.addListener(() => { ... });
  • emit: T extends undefined
        ? (() => void)
        : ((opts: T) => void)

    Emits an event to all listeners with the provided options.

    Param: opts

    Options to be passed to the listener

    Returns

    void

    Usage

    dispatcher.emit();
  • removeAllListeners: (() => void)

    Removes all event listeners from the dispatcher.

      • (): void

      • Returns void

        Usage

        dispatcher.removeAllListeners();
  • removeListener: ((id: number) => void)

    Removes an event listener

      • (id): void

      • Parameters

        • id: number

        Returns void

        Usage

        dispatcher.removeListener(listenerId);

Settings

Member Visibility

On This Page

ExamplesUsageUsageUsageUsage