Class CoreEvent<Context, Result>

Type parameters

Context: unknown[] = unknown[]
Result = unknown

Hierarchy

CoreEvent

Index

Constructors

constructor

Properties

Accessors

registeredPluginIdentifier

Methods

Constructors

constructor

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

- Defined in src/core/events/index.ts:22
Type parameters
- Context: unknown[] = unknown[]
- Result = unknown
Parameters
- name: string
Returns CoreEvent<Context, Result>

Properties

Readonly name

name: string

Private Optional plugin

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

Accessors

registeredPluginIdentifier

get registeredPluginIdentifier(): undefined | string

- Defined in src/core/events/index.ts:24
Returns undefined | string

Methods

deregisterPlugin

deregisterPlugin(): void

- Defined in src/core/events/index.ts:55
Deregisters the currently registered plugin.

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

Returns void

registerPlugin

registerPlugin(plugin: default<CoreEvent<Context, Result>>): void

- Defined in src/core/events/index.ts:33
Registers a plugin that listens to this event.

Parameters
- plugin: default<CoreEvent<Context, Result>>
  
  The plugin to register.
Returns void

trigger

trigger(...args: Context): void | Result

- Defined in src/core/events/index.ts:67
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