Class PublishBuilder

Builder for PUBLISH packets.

Index

Constructors

Methods

build contentType correlationData dup expiry packetId payload payloadFormat properties qos responseTopic retain subscriptionId topicAlias userProperty

Constructors

constructor

new PublishBuilder(topic: string): PublishBuilder
Parameters
- topic: string
Returns PublishBuilder
- Defined in testing/builders.ts:376

Methods

build

build(): PublishPacket
Build the PUBLISH packet

Returns PublishPacket
- Defined in testing/builders.ts:473

contentType

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

correlationData

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

dup

dup(value?: boolean): this
Set duplicate delivery flag
Parameters
- value: boolean = true
Returns this
- Defined in testing/builders.ts:399

expiry

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

packetId

packetId(id: number): this
Set packet identifier (required for QoS > 0)
Parameters
- id: number
Returns this
- Defined in testing/builders.ts:381

payload

payload(value: string | Uint8Array<ArrayBufferLike>): this
Set payload
Parameters
- value: string | Uint8Array<ArrayBufferLike>
Returns this
- Defined in testing/builders.ts:405

payloadFormat

payloadFormat(indicator: 0 | 1): this
Set payload format indicator
Parameters
- indicator: 0 | 1
Returns this
- Defined in testing/builders.ts:417

properties

properties(props: PublishProperties): this
Set PUBLISH properties
Parameters
- props: PublishProperties
Returns this
- Defined in testing/builders.ts:411

qos

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

responseTopic

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

retain

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

subscriptionId

subscriptionId(id: number): this
Add subscription identifier
Parameters
- id: number
Returns this
- Defined in testing/builders.ts:453

topicAlias

topicAlias(alias: number): this
Set topic alias
Parameters
- alias: number
Returns this
- Defined in testing/builders.ts:429

userProperty

userProperty(key: string, value: string): this
Add user property
Parameters
- key: string
- value: string
Returns this
- Defined in testing/builders.ts:463