Class AuthBuilder

Builder for AUTH packets (MQTT 5.0 only).

Index

Constructors

Methods

build continueAuth data method properties reasonCode reasonString reAuth success userProperty

Constructors

constructor

new AuthBuilder(reasonCode?: ReasonCode): AuthBuilder
Parameters
- reasonCode: ReasonCode = 0x00
Returns AuthBuilder
- Defined in testing/builders.ts:975

Methods

build

build(): AuthPacket
Build the AUTH packet

Returns AuthPacket
- Defined in testing/builders.ts:1038

continueAuth

continueAuth(): this
Set continue authentication (0x18)

Returns this
- Defined in testing/builders.ts:992

data

data(value: Uint8Array): this
Set authentication data
Parameters
- value: Uint8Array
Returns this
- Defined in testing/builders.ts:1016

method

method(value: string): this
Set authentication method
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:1010

properties

properties(props: AuthProperties): this
Set AUTH properties
Parameters
- props: AuthProperties
Returns this
- Defined in testing/builders.ts:1004

reasonCode

reasonCode(code: ReasonCode): this
Set reason code
Parameters
- code: ReasonCode
Returns this
- Defined in testing/builders.ts:980

reasonString

reasonString(value: string): this
Set reason string
Parameters
- value: string
Returns this
- Defined in testing/builders.ts:1022

reAuth

reAuth(): this
Set re-authenticate (0x19)

Returns this
- Defined in testing/builders.ts:998

success

success(): this
Set success (0x00)

Returns this
- Defined in testing/builders.ts:986

userProperty

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