Type Alias WillProperties

Will message properties (MQTT 5.0).

type WillProperties = {
    contentType?: string;
    correlationData?: Uint8Array;
    messageExpiryInterval?: number;
    payloadFormatIndicator?: 0 | 1;
    responseTopic?: string;
    userProperties?: readonly UserProperty[];
    willDelayInterval?: number;
}

Index

Properties

contentType? correlationData? messageExpiryInterval? payloadFormatIndicator? responseTopic? userProperties? willDelayInterval?

Properties

`Optional` `Readonly`contentType

contentType?: string

Content type (MIME)

`Optional` `Readonly`correlationData

correlationData?: Uint8Array

Correlation data

`Optional` `Readonly`messageExpiryInterval

messageExpiryInterval?: number

Message expiry (seconds)

`Optional` `Readonly`payloadFormatIndicator

payloadFormatIndicator?: 0 | 1

Payload format: 0=bytes, 1=UTF-8

`Optional` `Readonly`responseTopic

responseTopic?: string

Response topic

`Optional` `Readonly`userProperties

userProperties?: readonly UserProperty[]

User properties

`Optional` `Readonly`willDelayInterval

willDelayInterval?: number

Delay before publishing will (seconds)