Class ProxyBus<E>

Type Parameters

E extends GenericEvents = NextcloudEvents

Implements

EventBus<E>

Index

Constructors

Methods

emit getVersion subscribe unsubscribe

Constructors

constructor

new ProxyBus<E extends GenericEvents = NextcloudEvents>(
bus: EventBus<E>,
): ProxyBus<E>
Type Parameters
- E extends GenericEvents = NextcloudEvents
Parameters
- bus: EventBus<E>
Returns ProxyBus<E>
- Defined in ProxyBus.ts:19

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
Implementation of EventBus.emit
- Defined in ProxyBus.ts:52

getVersion

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

Returns string
Implementation of EventBus.getVersion
- Defined in ProxyBus.ts:34

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
Implementation of EventBus.subscribe
- Defined in ProxyBus.ts:38

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
Implementation of EventBus.unsubscribe
- Defined in ProxyBus.ts:45