PluginEvent

Provides the data / event passed to all invoked methods in invokeSyncEvent. The event.data field is returned to the caller. Before returning though additional the following additional metadata is attached:

(number) $$plugin_invoke_count - The count of plugins invoked.

(Array

<string>

) $$plugin_invoke_names - The names of plugins invoked.

Index

Constructors

• constructor

Properties

• data
• eventbus
• extra
• ignoreKeys
• pluginName
• pluginOptions
• projectReport
• settings
• syntaxes

Constructors

constructor

• new PluginEvent(copyProps?: {}, passthruProps?: {}, extraEventData?: any): default

• Initializes PluginEvent.

  ---

  Parameters

  • copyProps: {} = {}

    Event data to copy.

  • passthruProps: {} = {}

    Event data to pass through.

  • extraEventData: any = ...

    Extra event data attached to extra.

  Returns default

Properties

data

data: any

Provides the unified event data assigning any pass through data to the copied data supplied.

eventbus

eventbus: EventEmitter

The active EventProxy for that particular plugin.

extra

extra: any

Stores any extra event data added to all PluginEvents.

ignoreKeys

ignoreKeys: any

list of keys to ignore

pluginName

pluginName: string

The active plugin name.

pluginOptions

pluginOptions: any

The active plugin options.

projectReport

projectReport: default

TODO: i don’t know where this is set, but it is used in excomplex-project/plugins

settings

settings: any

settings for the plugin instance

syntaxes

syntaxes: any

All loaded trait syntaxes for AST nodes