Interface MQTTOptions

interface MQTTOptions {
    ALPNProtocols?:
        | Buffer<ArrayBufferLike>
        | Uint8Array<ArrayBufferLike>
        | string[]
        | Buffer<ArrayBufferLike>[]
        | Uint8Array<ArrayBufferLike>[];
    auth?: string;
    authPacket?: Partial<IAuthPacket>;
    autoAssignTopicAlias?: boolean;
    autoReconnect?: boolean;
    autoUseTopicAlias?: boolean;
    binary?: boolean;
    brokerUrl: string;
    browserBufferSize?: number;
    browserBufferTimeout?: number;
    ca?:
        | string
        | Buffer<ArrayBufferLike>
        | string[]
        | Buffer<ArrayBufferLike>[];
    caPaths?: string | string[];
    cert?:
        | string
        | Buffer<ArrayBufferLike>
        | string[]
        | Buffer<ArrayBufferLike>[];
    certPath?: string;
    clean?: boolean;
    clientId: string;
    connectTimeout?: number;
    createWebsocket?: (
        url: string,
        websocketSubProtocols: string[],
        options: IClientOptions,
    ) => any;
    customHandleAcks?: AckHandler;
    defaultProtocol?: MqttProtocol;
    encoding?: BufferEncoding;
    forceNativeWebSocket?: boolean;
    host?: string;
    hostname?: string;
    incomingStore?: IStore;
    keepalive?: number;
    key?:
        | string
        | any[]
        | Buffer<ArrayBufferLike>
        | string[]
        | Buffer<ArrayBufferLike>[];
    keyPath?: string;
    log?: (...args: any[]) => void;
    manualConnect?: boolean;
    messageIdProvider?: IMessageIdProvider;
    my?: any;
    objectMode?: boolean;
    outgoingStore?: IStore;
    password?: string | Buffer<ArrayBufferLike>;
    path?: string;
    port?: number;
    properties?: {
        authenticationData?: Buffer<ArrayBufferLike>;
        authenticationMethod?: string;
        maximumPacketSize?: number;
        receiveMaximum?: number;
        requestProblemInformation?: boolean;
        requestResponseInformation?: boolean;
        sessionExpiryInterval?: number;
        topicAliasMaximum?: number;
        userProperties?: UserProperties;
    };
    protocol?: MqttProtocol;
    protocolId?: "MQTT"
    | "MQIsdp";
    protocolVersion?: 5 | 3 | 4;
    query?: Record<string, string>;
    queueQoSZero?: boolean;
    reconnectInterval?: number;
    reconnectOnConnackError?: boolean;
    reconnectPeriod?: number;
    rejectUnauthorized?: boolean;
    reschedulePings?: boolean;
    resubscribe?: boolean;
    servername?: string;
    servers?: {
        host: string;
        port: number;
        protocol?: "wss" | "ws" | "mqtt" | "mqtts" | "tcp" | "ssl" | "wx" | "wxs";
    }[];
    socksProxy?: string;
    socksTimeout?: number;
    subscribeBatchSize?: number;
    timerVariant?: TimerVariant
    | Timer;
    topicPrefix?: string;
    transformWsUrl?: (
        url: string,
        options: IClientOptions,
        client: MqttClient,
    ) => string;
    unixSocket?: boolean;
    username?: string;
    will?: {
        payload: string | Buffer<ArrayBufferLike>;
        properties?: {
            contentType?: string;
            correlationData?: Buffer<ArrayBufferLike>;
            messageExpiryInterval?: number;
            payloadFormatIndicator?: boolean;
            responseTopic?: string;
            userProperties?: UserProperties;
            willDelayInterval?: number;
        };
        qos?: QoS;
        retain?: boolean;
        topic: string;
    };
    writeCache?: boolean;
    wsOptions?: ClientOptions
    | ClientRequestArgs
    | DuplexOptions;
}