Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CoreEvent<Context, Result>

Type parameters

  • Context: unknown[] = unknown[]

  • Result = unknown

Hierarchy

  • CoreEvent

Index

Constructors

constructor

  • new CoreEvent<Context, Result>(name: string): CoreEvent<Context, Result>

Properties

Readonly name

name: string

Private Optional plugin

plugin?: default<CoreEvent<Context, Result>>

Accessors

registeredPluginIdentifier

  • get registeredPluginIdentifier(): undefined | string

Methods

deregisterPlugin

  • deregisterPlugin(): void
  • Deregisters the currently registered plugin.

    If no plugin is currently registered this is a no-op.

    Returns void

registerPlugin

trigger

  • trigger(...args: Context): void | Result
  • Triggers this event.

    Will execute the action of the registered plugin, if there is any.

    Parameters

    • Rest ...args: Context

      The arguments to be passed as context to the registered plugin.

    Returns void | Result

    The result from the plugin execution.

Generated using TypeDoc