@gatling.io/mqtt/target/subscribe.d.ts

Gatling JS is a JavaScript/TypeScript interface for the [Gatling load testing tool](https://gatling.io/).

import { ActionBuilder, CheckBuilder, Duration } from "@gatling.io/core";
import JvmSubscribeActionBuilder = io.gatling.javaapi.mqtt.SubscribeActionBuilder;
export declare namespace SubscribeActionBuilder {
    import JvmCheckable = io.gatling.javaapi.mqtt.SubscribeActionBuilder$Checkable;
    interface Checkable extends ActionBuilder {
        /**
         * Use an at-most-once QoS
         *
         * @returns a new ActionBuilder instance
         */
        qosAtMostOnce(): SubscribeActionBuilder;
        /**
         * Use an at-least-once QoS
         *
         * @returns a new ActionBuilder instance
         */
        qosAtLeastOnce(): SubscribeActionBuilder;
        /**
         * Use an exactly-once QoS
         *
         * @returns a new ActionBuilder instance
         */
        qosExactlyOnce(): SubscribeActionBuilder;
        /**
         * Apply some checks
         *
         * @param checks - the checks
         * @returns a new ActionBuilder instance
         */
        check(...checks: Array<CheckBuilder>): SubscribeActionBuilder.Checkable;
    }
    const wrapCheckable: (_underlying: JvmCheckable) => Checkable;
}
/**
 * DSL for actions that subscribe to MQTT topics
 *
 * <p>Immutable, so all methods return a new occurrence and leave the original unmodified.
 */
export interface SubscribeActionBuilder extends ActionBuilder {
    /**
     * Use an at-most-once QoS
     *
     * @returns a new ActionBuilder instance
     */
    qosAtMostOnce(): SubscribeActionBuilder;
    /**
     * Use an at-least-once QoS
     *
     * @returns a new ActionBuilder instance
     */
    qosAtLeastOnce(): SubscribeActionBuilder;
    /**
     * Use an exactly-once QoS
     *
     * @returns a new ActionBuilder instance
     */
    qosExactlyOnce(): SubscribeActionBuilder;
    /**
     * Wait for the checks to complete
     *
     * @param timeout - the check timeout
     * @returns a new ActionBuilder instance
     */
    await(timeout: Duration): SubscribeActionBuilder.Checkable;
    /**
     * Perform checks in the background, meaning state will have to be reconciled with {@link
     * MqttDsl#waitForMessages()}
     *
     * @param timeout - the check timeout
     * @returns the next DSL step
     */
    expect(timeout: Duration): SubscribeActionBuilder.Checkable;
}
export declare const wrapSubscribeActionBuilder: (_underlying: JvmSubscribeActionBuilder) => SubscribeActionBuilder;