Class WillBuilder

Builder for will messages.

Index

Constructors

Methods

build contentType correlationData delay expiry properties qos responseTopic retain

Constructors

constructor

new WillBuilder(topic: string, payload: Uint8Array): WillBuilder
Parameters
- topic: string
- payload: Uint8Array
Returns WillBuilder
- Defined in testing/builders.ts:202

Methods

build

build(): WillMessage
Build the will message

Returns WillMessage
- Defined in testing/builders.ts:256

contentType

contentType(value: string): this
Set content type
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:238

correlationData

correlationData(data: Uint8Array): this
Set correlation data
Parameters
- data: Uint8Array
Returns this
- Defined in testing/builders.ts:250

delay

delay(seconds: number): this
Set will delay interval
Parameters
- seconds: number
Returns this
- Defined in testing/builders.ts:226

expiry

expiry(seconds: number): this
Set message expiry interval
Parameters
- seconds: number
Returns this
- Defined in testing/builders.ts:232

properties

properties(props: WillProperties): this
Set will properties
Parameters
- props: WillProperties
Returns this
- Defined in testing/builders.ts:220

qos

qos(value: QoS): this
Set QoS level
Parameters
- value: QoS
Returns this
- Defined in testing/builders.ts:208

responseTopic

responseTopic(topic: string): this
Set response topic
Parameters
- topic: string
Returns this
- Defined in testing/builders.ts:244

retain

retain(value?: boolean): this
Enable retain flag
Parameters
- value: boolean = true
Returns this
- Defined in testing/builders.ts:214