Class SubscribeBuilder

Builder for SUBSCRIBE packets.

Index

Constructors

Methods

add build noLocal properties retainAsPublished retainHandling subscriptionId topic userProperty

Constructors

constructor

new SubscribeBuilder(
    packetId: number,
    topicFilter?: string,
    options?: Partial<SubscriptionOptions>,
): SubscribeBuilder
Parameters
- packetId: number
- OptionaltopicFilter: string
- Optionaloptions: Partial<SubscriptionOptions>
Returns SubscribeBuilder
- Defined in testing/builders.ts:590

Methods

add

add(topicFilter: string, options?: Partial<SubscriptionOptions>): this
Add a subscription
Parameters
- topicFilter: string
- options: Partial<SubscriptionOptions> = {}
Returns this
- Defined in testing/builders.ts:601

build

build(): SubscribePacket
Build the SUBSCRIBE packet

Returns SubscribePacket
- Defined in testing/builders.ts:673

noLocal

noLocal(value?: boolean): this
Set no local flag on last subscription
Parameters
- value: boolean = true
Returns this
- Defined in testing/builders.ts:615

properties

properties(props: SubscribeProperties): this
Set SUBSCRIBE properties
Parameters
- props: SubscribeProperties
Returns this
- Defined in testing/builders.ts:651

retainAsPublished

retainAsPublished(value?: boolean): this
Set retain as published flag on last subscription
Parameters
- value: boolean = true
Returns this
- Defined in testing/builders.ts:627

retainHandling

retainHandling(value: 0 | 1 | 2): this
Set retain handling on last subscription
Parameters
- value: 0 | 1 | 2
Returns this
- Defined in testing/builders.ts:639

subscriptionId

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

topic

topic(topicFilter: string, qos?: QoS): this
Add a subscription with QoS
Parameters
- topicFilter: string
- qos: QoS = 0
Returns this
- Defined in testing/builders.ts:610

userProperty

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