Class AbstractPlugin<TEvents>`Abstract`

Base class for plugins

Type Parameters

TEvents extends TypedEvent<AbstractPlugin> = never
union of dispatched events

Hierarchy (View Summary)

TypedEventTarget<TEvents>
- AbstractPlugin

Index

Constructors

Properties

viewer id VERSION

Methods

addEventListener destroy dispatchEvent init removeEventListener

Constructors

constructor

new AbstractPlugin<TEvents extends TypedEvent<AbstractPlugin<never>> = never>(
viewer: Viewer,
): AbstractPlugin<TEvents>
Type Parameters
- TEvents extends TypedEvent<AbstractPlugin<never>> = never
Parameters
- viewer: Viewer
Returns AbstractPlugin<TEvents>
Overrides TypedEventTarget.constructor
- Defined in packages/core/src/plugins/AbstractPlugin.ts:22

Properties

`Protected`viewer

viewer: Viewer

`Static` `Readonly`id

id: string

Unique identifier of the plugin

`Static` `Readonly`VERSION

VERSION: string

Expected version of the core DO NOT USE on custom plugins

Methods

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
Inherited from TypedEventTarget.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

destroy

destroy(): void
Destroys the plugin

Returns void
- Defined in packages/core/src/plugins/AbstractPlugin.ts:36

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
Inherited from TypedEventTarget.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

init

init(): void
Initializes the plugin

Returns void
- Defined in packages/core/src/plugins/AbstractPlugin.ts:30

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
Inherited from TypedEventTarget.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41