Class AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>Abstract

Static Readonlyid

Static ReadonlyVERSION

addEventListener

• addEventListener<
      T extends string,
      E extends TypedEvent<AbstractPlugin<never>> & { type: T },
  >(
      type: T,
      callback: EventListenerObject | ((e: E) => void),
      options?: boolean | AddEventListenerOptions,
  ): void

  Type Parameters

  • T extends string

    the name of event
  • E extends TypedEvent<AbstractPlugin<never>> & { type: T }

    the class of the event

  Parameters

  • type: T
  • callback: EventListenerObject | ((e: E) => void)
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

destroy

• destroy(): void

  Destroys the plugin

  Returns void

dispatchEvent

• dispatchEvent(e: TEvents): boolean

  Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

  MDN Reference

  Parameters

  • e: TEvents

  Returns boolean

init

• init(): void

  Initializes the plugin

  Returns void

removeEventListener

• removeEventListener<
      T extends string,
      E extends TypedEvent<AbstractPlugin<never>> & { type: T },
  >(
      type: TEvents["type"],
      callback: EventListenerObject | ((e: E) => void),
      options?: boolean | EventListenerOptions,
  ): void

  Type Parameters

  • T extends string

    the name of event
  • E extends TypedEvent<AbstractPlugin<never>> & { type: T }

    the class of the event

  Parameters

  • type: TEvents["type"]
  • callback: EventListenerObject | ((e: E) => void)
  • Optionaloptions: boolean | EventListenerOptions

  Returns void