Interface EventBus<E>

interface EventBus<E> {
    emit<EventName>(name, event): void;
    getVersion(): string;
    subscribe<EventName>(name, handler): void;
    unsubscribe<EventName>(name, handler): void;
}

Type Parameters

E extends GenericEvents = NextcloudEvents

Implemented by

Index

Methods

emit getVersion subscribe unsubscribe

Methods

emit

emit<EventName>(name, event): void
Emit an event on the event bus
Type Parameters
- EventName extends string | number | symbol
Parameters
- name: EventName
  Name of the event to emit
- event: E[EventName]
  Event payload to emit
Returns void
- Defined in EventBus.ts:40

getVersion

getVersion(): string
Get the version of this event bus instance This is used for compatibility checking

Returns string
- Defined in EventBus.ts:13

subscribe

subscribe<EventName>(name, handler): void
Subscribe the event bus
Type Parameters
- EventName extends string | number | symbol
Parameters
- name: EventName
  Name of the event to subscribe
- handler: EventHandler<E[EventName]>
  Handler ivoken when receiving the event
Returns void
- Defined in EventBus.ts:20

unsubscribe

unsubscribe<EventName>(name, handler): void
Unsubscribe a handler on one event from the event bus
Type Parameters
- EventName extends string | number | symbol
Parameters
- name: EventName
  Name of the event to unsubscribe
- handler: EventHandler<E[EventName]>
  Handler to unsubscribe
Returns void
- Defined in EventBus.ts:30