@gatling.io/core/target/population.d.ts

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

import { Duration } from "./utils/duration";
import { PauseType } from "./structure/pauses";
import { Wrapper } from "./common";
import { ProtocolBuilder } from "./protocol";
import { SessionTo } from "./session";
import { ThrottleStep } from "./throttling";
import JvmPopulationBuilder = io.gatling.javaapi.core.PopulationBuilder;
/**
 * A builder for a Population = a Scenario + an injection profile.
 *
 * Immutable, meaning each method doesn't mutate the current instance but return a new one.
 */
export interface PopulationBuilder extends Wrapper<JvmPopulationBuilder> {
    /**
     * Define the optional protocols for this PopulationBuilder
     *
     * @param protocols - the protocols
     * @returns a new PopulationBuilder
     */
    protocols(...protocols: ProtocolBuilder[]): PopulationBuilder;
    /**
     * Define some other PopulationBuilder to be executed once all the users of this PopulationBuilder
     * complete their Scenario.
     *
     * @param children - the children PopulationBuilder
     * @returns a new PopulationBuilder
     */
    andThen(...children: PopulationBuilder[]): PopulationBuilder;
    /**
     * Disable the pauses
     *
     * @return a new PopulationBuilder
     */
    disablePauses(): PopulationBuilder;
    /**
     * Use constant pauses
     *
     * @return a new PopulationBuilder
     */
    constantPauses(): PopulationBuilder;
    /**
     * Use exponential pauses
     *
     * @return a new PopulationBuilder
     */
    exponentialPauses(): PopulationBuilder;
    /**
     * Use custom pauses
     *
     * @return a new PopulationBuilder
     */
    customPauses(f: SessionTo<number>): PopulationBuilder;
    /**
     * Use uniform pauses with a standard deviation percentage
     *
     * @return a new PopulationBuilder
     */
    uniformPauses(plusOrMinus: Duration): PopulationBuilder;
    /**
     * Use pauses configured with a given strategy
     *
     * @param pauseType the pause type
     * @return a new PopulationBuilder
     */
    pauses(pauseType: PauseType): PopulationBuilder;
    /**
     * Define the optional throttling profile
     *
     * @param throttleSteps the throttling profile steps
     * @return a new PopulationBuilder
     */
    throttle(...throttleSteps: ThrottleStep[]): PopulationBuilder;
    /**
     * Disable the injection profile sharding that happens normally when running with Gatling
     * Enterprise. Only effective when the test is running with Gatling Enterprise, noop otherwise.
     *
     * @return a new PopulationBuilder
     */
    noShard(): PopulationBuilder;
}
export declare const wrapPopulationBuilder: (_underlying: JvmPopulationBuilder) => PopulationBuilder;