Properties
Optional ca
ca: string | string[] | Buffer | Buffer[]
Optional cert
cert: string | string[] | Buffer | Buffer[]
Optional clean
clean: boolean
Optional clientId
clientId: string
Optional connectTimeout
connectTimeout: number
Optional host
host: string
Optional hostname
hostname: string
Optional incomingStore
incomingStore: any
Optional keepalive
keepalive: number
Optional key
key: string | string[] | Buffer | Buffer[] | Record<string, any>[]
Optional outgoingStore
outgoingStore: any
Optional password
password: string
Optional path
path: string
Optional port
port: number
Optional protocol
protocol: "wss" | "ws" | "mqtt" | "mqtts" | "tcp" | "ssl" | "wx" | "wxs"
Optional protocolId
protocolId: string
Optional protocolVersion
protocolVersion: number
Optional queueQoSZero
queueQoSZero: boolean
Optional reconnectPeriod
reconnectPeriod: number
Optional rejectUnauthorized
rejectUnauthorized: boolean
Optional reschedulePings
reschedulePings: boolean
Optional resubscribe
resubscribe: boolean
Optional servers
servers: Array<{ host: string; port: number }>
Optional transformWsUrl
transformWsUrl: (url: string, options: any, client: any) => string
Type declaration
-
- (url: string, options: any, client: any): string
-
Parameters
-
url: string
-
options: any
-
client: any
Returns string
Optional username
username: string
Optional will
will
: { payload
: string; qos
: QoS; retain
: boolean; topic
: string }
Type declaration
-
payload: string
-
-
retain: boolean
-
topic: string
Optional wsOptions
wsOptions: {}
Optionally override the trusted CA certificates in PEM format