Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventTargetFoundation

Class representing the events broker agent

Abstraction needed because there are more than two ways to handle Custom Events.

Ex:

   window.dispatchEvent(...);

   document.dispatchEvent(...);

   element.dispatchEvent(...);

   new EventTarget().dispatchEvent(...)

This class creates the API to use an unique interface implementation for the Publish/Subscribe Design Pattern sitting on top of the standard Custom Events Web API.

Hierarchy

  • EventTargetFoundation

Index

Methods

publishEvent

  • publishEvent(event: Event | CustomEvent): boolean

subscribeEventListener

  • subscribeEventListener(__namedParameters: object): void
  • Method to subscribe/register a listener to a given event

    Parameters

    • __namedParameters: object
      • listener: null | EventListener | EventListenerObject
      • options: undefined | false | true | AddEventListenerOptions
      • type: string

    Returns void

unsubscribeEventListener

  • unsubscribeEventListener(__namedParameters: object): void
  • Method to un-subscribe/un-register a listener to a given event

    Parameters

    • __namedParameters: object
      • callback: null | EventListener | EventListenerObject
      • options: undefined | false | true | EventListenerOptions
      • type: string

    Returns void

Object literals

Private eventTarget

eventTarget: object

addEventListener

addEventListener: addEventListener = window.addEventListener

dispatchEvent

dispatchEvent: dispatchEvent = window.dispatchEvent

removeEventListener

removeEventListener: removeEventListener = window.removeEventListener

Generated using TypeDoc