@gatling.io/core 3.11.6 → 3.11.7

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@gatling.io/core",
-  "version": "3.11.6",
+  "version": "3.11.7",
   "license": "Apache-2.0",
   "main": "target/index.js",
   "types": "target/index.d.ts",
   "dependencies": {
-    "@gatling.io/jvm-types": "3.11.6"
+    "@gatling.io/jvm-types": "3.11.7"
   },
   "devDependencies": {
     "@types/jest": "29.5.12",
@@ -14,7 +14,7 @@
     "rimraf": "6.0.1",
     "ts-jest": "29.2.3",
     "ts-node": "10.9.2",
-    "typescript": "5.5.3"
+    "typescript": "5.5.4"
   },
   "scripts": {
     "clean": "rimraf target",

package/target/index.d.ts

@@ -19,7 +19,7 @@ export * from "./filters";
 export { GlobalStore } from "./globalStore";
 export * from "./openInjection";
 export * from "./population";
-export { getOption, getEnvironmentVariable, GetWithDefault } from "./parameters";
+export { getParameter, getOption, getEnvironmentVariable, GetWithDefault } from "./parameters";
 export * from "./protocol";
 export * from "./scenario";
 export * from "./session";

package/target/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.simulation = exports.getEnvironmentVariable = exports.getOption = exports.GlobalStore = exports.asByteArrayFunction = exports.asByteArray = void 0;
+exports.simulation = exports.getEnvironmentVariable = exports.getOption = exports.getParameter = exports.GlobalStore = exports.asByteArrayFunction = exports.asByteArray = void 0;
 require("@gatling.io/jvm-types");
 const pauses_1 = require("./structure/pauses");
 const duration_1 = require("./utils/duration");
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "GlobalStore", { enumerable: true, get: function
 __exportStar(require("./openInjection"), exports);
 __exportStar(require("./population"), exports);
 var parameters_1 = require("./parameters");
+Object.defineProperty(exports, "getParameter", { enumerable: true, get: function () { return parameters_1.getParameter; } });
 Object.defineProperty(exports, "getOption", { enumerable: true, get: function () { return parameters_1.getOption; } });
 Object.defineProperty(exports, "getEnvironmentVariable", { enumerable: true, get: function () { return parameters_1.getEnvironmentVariable; } });
 __exportStar(require("./protocol"), exports);

package/target/parameters.d.ts

@@ -3,14 +3,19 @@ export interface GetWithDefault {
     (name: string, defaultValue: string): string;
 }
 /**
- * Gets the option indicated by the specified name.
+ * Gets the parameter indicated by the specified name.
  *
- * Options can be specified in the `gatling run` command by passing arguments with the format `key=value`, e.g.
- * `gatling run option1=foo option2=bar`.
+ * Parameters can be specified in the `gatling run` command by passing arguments with the format `key=value`, e.g.
+ * `gatling run parameter1=foo parameter2=bar`. You would then retrieve them in your simulation by calling
+ * `getParameter("parameter1")` and `getParameter("parameter2")`.
  *
- * @param key - the key of the option.
+ * @param key - the key of the parameter.
  * @param defaultValue - a default value
- * @returns the string value of the option if it is defined, or else `defaultValue` if provided, or else `undefined`.
+ * @returns the string value of the parameter if it is defined, or else `defaultValue` if provided, or else `undefined`.
+ */
+export declare const getParameter: GetWithDefault;
+/**
+ * @deprecated Use {@link getParameter} instead.
  */
 export declare const getOption: GetWithDefault;
 /**

package/target/parameters.js

@@ -1,19 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnvironmentVariable = exports.getOption = void 0;
+exports.getEnvironmentVariable = exports.getOption = exports.getParameter = void 0;
 const jvm_types_1 = require("@gatling.io/jvm-types");
 /**
- * Gets the option indicated by the specified name.
+ * Gets the parameter indicated by the specified name.
  *
- * Options can be specified in the `gatling run` command by passing arguments with the format `key=value`, e.g.
- * `gatling run option1=foo option2=bar`.
+ * Parameters can be specified in the `gatling run` command by passing arguments with the format `key=value`, e.g.
+ * `gatling run parameter1=foo parameter2=bar`. You would then retrieve them in your simulation by calling
+ * `getParameter("parameter1")` and `getParameter("parameter2")`.
  *
- * @param key - the key of the option.
+ * @param key - the key of the parameter.
  * @param defaultValue - a default value
- * @returns the string value of the option if it is defined, or else `defaultValue` if provided, or else `undefined`.
+ * @returns the string value of the parameter if it is defined, or else `defaultValue` if provided, or else `undefined`.
  */
-const getOption = (key, defaultValue) => getOrElse(jvm_types_1.System.getProperty(key), defaultValue);
-exports.getOption = getOption;
+const getParameter = (key, defaultValue) => getOrElse(jvm_types_1.System.getProperty(key), defaultValue);
+exports.getParameter = getParameter;
+/**
+ * @deprecated Use {@link getParameter} instead.
+ */
+exports.getOption = exports.getParameter;
 /**
  * Gets the environment variable indicated by the specified name.
  *