Interface ClientOptions

Options for creating a new MQTT client.

interface ClientOptions {
    client_id?: string;
    credentials_provider?: CredentialsProvider;
    password?: string;
    tags?: Record<string, string>;
    username?: string;
    will?: Will;
}

Hierarchy (View Summary)

HasTags
- ClientOptions

Index

Properties

client_id? credentials_provider? password? tags? username? will?

Properties

`Optional`client_id

client_id?: string

Client identifier (must be unique per broker connection).

`Optional`credentials_provider

credentials_provider?: CredentialsProvider

Provider for MQTT client credentials.

`Optional`password

password?: string

The password required by your broker, if any.

`Optional`tags

tags?: Record<string, string>

Optional tags for metrics and logging.

`Optional`username

username?: string

The username required by your broker, if any.

`Optional`will

will?: Will

Last Will and Testament message.