waytale - v0.3.0
    Preparing search index...

    Variable mixinEventEmitterConst

    mixinEventEmitter: {
        off(eventName: string, handler: eventHandler): void;
        on(eventName: string, handler: eventHandler): void;
        once(eventName: string, handler: eventHandler): void;
        trigger(eventName: string, ...args: any[]): void;
    } = ...

    Event emitter as mixin.

    Type Declaration

    • off: function
      • Unsubscribe from an event by name with a specific handler.

        Parameters

        • eventName: string

          event to unsubscribe from

        • handler: eventHandler

          callback handling the event

        Returns void

    • on: function
      • Subscribe to an event by name with a specific handler.

        Parameters

        • eventName: string

          event to subscribe to

        • handler: eventHandler

          callback handling the event

        Returns void

    • once: function
      • Subscribe to an event, but run the handler only once. After running exactly once the handler will be immediately unsubscribed.

        Parameters

        • eventName: string

          event to subscribe to

        • handler: eventHandler

          callback handling the event

        Returns void

    • trigger: function
      • Trigger the calls of the event handlers subscribed to the given event.

        Parameters

        • eventName: string

          event to trigger

        • ...args: any[]

          arguments to forward to the event handlers

        Returns void