pamoja for TypeScript - v0.2.0
    Preparing search index...

    Interface MqttClientOptions

    Connection settings for an MqttClient.

    interface MqttClientOptions {
        capacity?: number;
        clientId: string;
        host: string;
        keepAliveSecs?: number;
        maxPacketSize?: number;
        password?: string;
        port: number;
        qos?: Qos;
        tls?: MqttTls;
        username?: string;
        will?: MqttWill;
    }
    Index
    capacity? clientId host keepAliveSecs? maxPacketSize? password? port qos? tls? username? will?
    capacity?: number

    Bound on outstanding client requests. Defaults to 64 when omitted.

    clientId: string

    The MQTT client identifier presented to the broker.

    host: string

    The broker hostname or IP address.

    keepAliveSecs?: number

    Keep-alive interval in seconds. Defaults to 30 when omitted.

    maxPacketSize?: number

    The largest packet the connection sends or accepts, in bytes. Defaults to 10,240 when omitted. A publish that would be larger is refused and the connection stays up, but a larger packet arriving from the broker ends the connection, so every client that shares a topic needs a limit that fits it.

    password?: string

    The password to sign in with, which needs a username. It travels in the clear unless the connection uses MqttClientOptions.tls.

    port: number

    The broker TCP port, conventionally 1883 for plaintext MQTT.

    qos?: Qos

    Default quality of service. Defaults to AtLeastOnce when omitted.

    tls?: MqttTls

    TLS settings; a connection with them is secured, conventionally on port 8883.

    username?: string

    The name to sign in to the broker with.

    will?: MqttWill

    A message the broker publishes if the connection ends without a goodbye.

    Settings
    Member Visibility

    On This Page
    Properties