Function min

  • min<T>(array, iteratee?): number

  • Find the minimum in an array.

    Type Parameters

    • T

    Parameters

    • array: T[]

      An array.

    • Optional iteratee: ((obj) => number)

      The iteratee invoked on each element.

        • (obj): number

        • Parameters

          • obj: T

          Returns number

    Returns number

    Returns the minimum.

    Since

    0.5.1

    Example

    min([1, 2, 3])
    // => 1

    const objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }]
    min(objects, ({ n }) => n)
    // => 2

Settings

Member Visibility

Theme