Function min

min<T>(object: Iterable<T>, fn: ((first: T, second: T) => number)): T | undefined
Find the minimum value in an iterable.

Returns
The minimum value in the iterable. If multiple values are equivalent to the minimum, the left-most value is returned. If the iterable is empty, this returns undefined.

Complexity

Linear.

Example
```
import { min } from '@lumino/algorithm';

function numberCmp(a: number, b: number): number {
  return a - b;
}

min([7, 4, 0, 3, 9, 4], numberCmp);  // 0
```
Type Parameters
- T
Parameters
- object: Iterable<T>
  
  The iterable object to search.
- fn: ((first: T, second: T) => number)
  
  The 3-way comparison function to apply to the values. It should return < 0 if the first value is less than the second. 0 if the values are equivalent, or > 0 if the first value is greater than the second.
  - - (first: T, second: T): number
    - Parameters
      
      first: T
      
      second: T
      
      Returns number
Returns T | undefined
- Defined in packages/algorithm/src/find.ts:129

Generated using TypeDoc