Class Bus

constructor

• new Bus(name): Bus

• Parameters

  • name: string

    client name

  Returns Bus

name

Optional onDisconnect

Optional onFrame

pingInterval

timeout

connect

• connect(path): Promise<void>

• Connects the client

  Parameters

  • path: string

    UNIX socket or TCP host:port

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Disconnects the bus client

  Returns Promise<void>

isConnected

• isConnected(): boolean

• Is bus client connected

  Returns boolean

publish

• publish(topic, payload?, qos?): Promise<OpResult>

• Publishes a message to a topic

  Parameters

  • topic: string

    the target topic

  • Optional payload: Buffer

    payload

  • Optional qos: QoS

    QoS

  Returns Promise<OpResult>

send

• send(target, payload?, qos?): Promise<OpResult>

• Sends a message to the target

  Parameters

  • target: string

    bus target

  • Optional payload: Buffer

    payload

  • Optional qos: QoS

    QoS

  Returns Promise<OpResult>

subscribe

• subscribe(topics): Promise<OpResult>

• Subscribes client to topic(s)

  Parameters

  • topics: string | string[]

    topics to subscribe

  Returns Promise<OpResult>

unsubscribe

• unsubscribe(topics): Promise<OpResult>

• Unsubscribes client from topic(s)

  Parameters

  • topics: string[]

    topics to unsubscribe

  Returns Promise<OpResult>