Class EventRegistry

Contains event handler registrations for a script.

Access the registry through the global events object.

Hierarchy

EventRegistry

Index

Constructors

constructor

Properties

handlers

Methods

Constructors

constructor

new EventRegistry(): EventRegistry

Returns EventRegistry

Properties

Protected handlers

handlers: {} = {}

Type declaration

[key: string]: EventHandler

Methods

Protected fire

fire(event: Event): string | void

- Defined in events.ts:121
Parameters
- event: Event
Returns string | void

Private newUUID

newUUID(): string

- Defined in events.ts:131
Returns string

on

on(eventSource: string, eventType: string, eventHandler: EventHandler): EventRegistry

- Defined in events.ts:55
Registers a handler to be run when a particular kind of event occurs. When Brigade receives a matching event, it will run the specified handler.

Possible event sources depend on the gateways configured in your Brigade system, and possible event types depend on the gateway. See the Brigade and gateway documentation for details.

Parameters
- eventSource: string
  
  The event source (gateway) to register the handler for
- eventType: string
  
  The event type to register the handler for
- eventHandler: EventHandler
  
  The handler to run when an event with the given source and type occurs
Returns EventRegistry

process

process(): void

- Defined in events.ts:64
Returns void

Generated using TypeDoc