ts-data-forge
    Preparing search index...

    Function min

    • Finds the minimum value in an array.

      Type Parameters

      • const Ar extends readonly number[]

      Parameters

      • array: Ar
      • Optionalcomparator: (x: Ar[number], y: Ar[number]) => number

      Returns Ar extends readonly [unknown, unknown]
          ? Readonly<{ value: Ar<Ar>[number] }>
          : Optional<Ar[number]>

      const values = [5, 3, 9] as const;
      const empty: readonly number[] = [];

      const smallest = Arr.min(values);
      const none = Arr.min(empty);
      const custom = Arr.min(values, (a, b) => b - a);

      assert.deepStrictEqual(smallest, Optional.some(3));
      assert.deepStrictEqual(none, Optional.none);
      assert.deepStrictEqual(custom, Optional.some(9));

    • Finds the minimum value in an array.

      Type Parameters

      • const Ar extends readonly unknown[]

      Parameters

      • array: Ar
      • comparator: (x: Ar[number], y: Ar[number]) => number

      Returns Ar extends readonly [unknown, unknown]
          ? Readonly<{ value: Ar<Ar>[number] }>
          : Optional<Ar[number]>

      const values = [5, 3, 9] as const;
      const empty: readonly number[] = [];

      const smallest = Arr.min(values);
      const none = Arr.min(empty);
      const custom = Arr.min(values, (a, b) => b - a);

      assert.deepStrictEqual(smallest, Optional.some(3));
      assert.deepStrictEqual(none, Optional.none);
      assert.deepStrictEqual(custom, Optional.some(9));

    Settings

    Member Visibility