Class UnsubscribeBuilder

Builder for UNSUBSCRIBE packets.

Index

Constructors

Methods

build properties topic userProperty

Constructors

constructor

new UnsubscribeBuilder(
packetId: number,
topicFilter?: string,
): UnsubscribeBuilder
Parameters
- packetId: number
- OptionaltopicFilter: string
Returns UnsubscribeBuilder
- Defined in testing/builders.ts:765

Methods

build

build(): UnsubscribePacket
Build the UNSUBSCRIBE packet

Returns UnsubscribePacket
- Defined in testing/builders.ts:795

properties

properties(props: UnsubscribeProperties): this
Set UNSUBSCRIBE properties
Parameters
- props: UnsubscribeProperties
Returns this
- Defined in testing/builders.ts:779

topic

topic(topicFilter: string): this
Add topic filter
Parameters
- topicFilter: string
Returns this
- Defined in testing/builders.ts:773

userProperty

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