Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MqttPublisherOptions

The interface contains the options of the getPublisher function.

Hierarchy

  • MqttOptions
    • MqttPublisherOptions

Index

Properties

Optional actions

The actions (topic and message) that you want to publish.

Optional host

host: string

Specifies the host to use in the url string. Note: overwritten by url property.

Optional onError

onError: (error: Error) => void

Specifies what will be executed in case of an error. Note: overwritten by the more-specific onError option whether specified in a certain topic.

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

Optional port

port: number

Specifies the port to use in the url string. Note: overwrites the port specified by type property but is overwritten by url property.

Optional protocol

protocol: string

Specifies the protocol to use in the url string. Note: overwrites the protocol specified by type property but is overwritten by url property.

Optional type

type: Protocol

If not overwritten, the protocol and the port will be determined by this property.

Optional url

url: string

Specifies the url used by the connection. Note: overwrites all the other properties that specify the url.

Generated using TypeDoc