Interface EventBus<E>

interface EventBus<E extends GenericEvents = NextcloudEvents> {
    emit<EventName extends string | number | symbol>(
        name: EventName,
        ...event: IsUndefined<E[EventName]> extends true ? [] : [E[EventName]],
    ): void;
    getVersion(): string;
    subscribe<EventName extends string | number | symbol>(
        name: EventName,
        handler: EventHandler<E[EventName]>,
    ): void;
    unsubscribe<EventName extends string | number | symbol>(
        name: EventName,
        handler: EventHandler<E[EventName]>,
    ): void;
}

Type Parameters

E extends GenericEvents = NextcloudEvents

Implemented by

Index

Methods

emit getVersion subscribe unsubscribe

Methods

emit

emit<EventName extends string | number | symbol>(
name: EventName,
...event: IsUndefined<E[EventName]> extends true ? [] : [E[EventName]],
): 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: IsUndefined<E[EventName]> extends true ? [] : [E[EventName]]
  Event payload to emit
Returns void
- Defined in EventBus.ts:45

getVersion

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

Returns string
- Defined in EventBus.ts:15

subscribe<EventName extends string | number | symbol>(
name: EventName,
handler: EventHandler<E[EventName]>,
): 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 invoked when receiving the event
Returns void
- Defined in EventBus.ts:23

unsubscribe

unsubscribe<EventName extends string | number | symbol>(
name: EventName,
handler: EventHandler<E[EventName]>,
): 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:34