MqttRecordBuilder

  
class MqttRecordBuilder<TData> {
  constructor(data?: TData)
  setData(data: TData): this
  setQoS(qos: 0 | 1 | 2): this
  setRetain(retain: boolean): this
  setDup(dup: boolean): this
  setProperties(properties: { payloadFormatIndicator?: boolean; messageExpiryInterval?: number; topicAlias?: number; responseTopic?: string; correlationData?: Buffer; userProperties?: Record<string, string | string[]>; subscriptionIdentifier?: number; contentType?: string; }): this
  build(): MqttRecord
}

Constructor


constructor(data?: TData)

Parameters

Option Type Description
data TData

Optional. Default is undefined.

Methods

setData()


setData(data: TData): this

Parameters

Option Type Description
data TData

Returns

this

setQoS()


setQoS(qos: 0 | 1 | 2): this

Parameters

Option Type Description
qos 0 | 1 | 2

Returns

this

setRetain()


setRetain(retain: boolean): this

Parameters

Option Type Description
retain boolean

Returns

this

setDup()


setDup(dup: boolean): this

Parameters

Option Type Description
dup boolean

Returns

this

setProperties()


setProperties(properties: { payloadFormatIndicator?: boolean; messageExpiryInterval?: number; topicAlias?: number; responseTopic?: string; correlationData?: Buffer; userProperties?: Record<string, string | string[]>; subscriptionIdentifier?: number; contentType?: string; }): this

Parameters

Option Type Description
properties object

Returns

this

build()


build(): MqttRecord

Parameters

There are no parameters.

Returns

MqttRecord