Method random

packages/trigger-sdk/src/io.ts:280–356

`io.random()` is identical to `Math.random()` when called without options but ensures your random numbers are not regenerated on resume or retry. It will return a pseudo-random floating-point number between optional `min` (default: 0, inclusive) and `max` (default: 1, exclusive). Can optionally `rou

(
    cacheKey: string | any[],
    {
      min = 0,
      max = 1,
      round = false,
    }: {
      min?: number;
      max?: number;
      round?: boolean;
    } = {}
  )

   * @param round Controls rounding to the nearest integer. Any `max` integer will become inclusive when enabled. Rounding with floating-point bounds may cause unexpected skew and boundary inclusivity.
   */
  async random(
    cacheKey: string | any[],
    {
      min = 0,
      max = 1,
      round = false,
    }: {
      min?: number;
      max?: number;
      round?: boolean;
    } = {}
  ) {
    return await this.runTask(
      cacheKey,
      async (task) => {
        if (min > max) {
          throw new Error(
            `Lower bound can't be higher than upper bound - min: ${min}, max: ${max}`
          );
        }

        if (min === max) {
          await this.logger.warn(
            `Lower and upper bounds are identical. The return value is not random and will always be: ${min}`
          );
        }

        const withinBounds = (max - min) * Math.random() + min;

        if (!round) {
          return withinBounds;
        }

        if (!Number.isInteger(min) || !Number.isInteger(max)) {
          await this.logger.warn(
            "Rounding enabled with floating-point bounds. This may cause unexpected skew and boundary inclusivity."
          );
        }

        const rounded = Math.round(withinBounds);

        return rounded;
      },
      {
        name: "random",
        icon: "dice-5-filled",
        params: { min, max, round },
        properties: [
          ...(min === 0
            ? []
            : [
                {
                  label: "min",
                  text: String(min),
                },
              ]),
          ...(max === 1
            ? []