Interface MessageBus

A messaging bus for sending and receiving messages

Hierarchy

MessageBus

Implemented by

DefaultMessageBus

Index

Methods

publish subscribe unsubscribe

Methods

publish

publish<T>(topic: string, message: T, options?: MessageBusOptions): Promise<void>
Publishes a message on a specified topic.
Type Parameters
- T
Parameters
- topic: string
  
  The topic on which the message will be sent.
- message: T
  
  The message to be sent.
- Optional options: MessageBusOptions
  
  Custom options for the message publish.
Returns Promise<void>
- Defined in desktopjs/src/ipc.ts:44

subscribe

subscribe<T>(topic: string, listener: ((event: any, message: T) => void), options?: MessageBusOptions): Promise<MessageBusSubscription>
Subscribe to messages sent to a specific topic.

Returns
Type Parameters
- T
Parameters
- topic: string
  
  The topic on which the messages will be received.
- listener: ((event: any, message: T) => void)
  
  Callback function for each message that is received.
  - - (event: any, message: T): void
    - Parameters
      
      event: any
      
      message: T
      
      Returns void
- Optional options: MessageBusOptions
  
  Custom options for subscription.
Returns Promise<MessageBusSubscription>
- Defined in desktopjs/src/ipc.ts:30

unsubscribe

unsubscribe(subscription: MessageBusSubscription): Promise<void>
Unsusbcribe to messages from a specified subscription.
Parameters
- subscription: MessageBusSubscription
  
  The subscription in which to unsubscribe.
Returns Promise<void>
- Defined in desktopjs/src/ipc.ts:36