Class Emitter

Like an EventEmitter, instances of this class allow us register and unregister listeners for events, but it allows listening for those messages that match a pattern.

Example

let x = new Emitter();
  x.addContentListener({foo: 'bar'}, (data) => {
    console.log('received data', data);
  });
  x.emit({foo: 'bar', hello: 'world'})

  > received data {foo: 'bar', hello: 'world'}

Hierarchy (view full)

Constructors

constructor

Properties

contentListeners

Methods

addContentListener emit match removeContentListener

Constructors

constructor

  • new Emitter(options?): Emitter

  • Parameters

    • Optional options: ConstructorOptions

    Returns Emitter

Properties

Private contentListeners

contentListeners: Listener[] = []

Methods

addContentListener

  • addContentListener(filter, fn): void

  • Add an event listener that will be called when an event that matches provided filter is received

    Parameters

    • filter: {
          cancel?: string;
          payload?: any;
          request?: string;
      }

      filter that should match emited events to call provided function

      • Optional cancel?: string
      • Optional payload?: any
      • Optional request?: string
    • fn: ((...args) => void)

      callback to invoke on each new match.

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

emit

Private match

  • match(item, filter): boolean

  • Check if given data matches provided filter.

    Parameters

    • item: string

      tested element.

    • filter: {
          cancel?: string;
          payload?: any;
          request?: string;
      }

      tested filter.

      • Optional cancel?: string
      • Optional payload?: any
      • Optional request?: string

    Returns boolean

    true if item matches filter.

removeContentListener

  • removeContentListener(fn): void

  • Stop receiving events on a previously added listener.

    Parameters

    • fn: ((...args) => void)

      callback to remove from listeners list.

        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcontentListenersaddContentListeneremitmatchremoveContentListener