Function max

max<const Ar extends readonly number[]>(
    array: Ar,
    comparator?: (x: Ar[number], y: Ar[number]) => number,
): Ar extends readonly [unknown, unknown]
    ? Readonly<{ value: Ar<Ar>[number] }>
    : Optional<Ar[number]>
Finds the maximum 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]>
Example
```
const values = [5, 3, 9];

const largest = Arr.max(values);
const reversed = Arr.max(values, (a, b) => b - a);

assert.deepStrictEqual(largest, Optional.some(9));
assert.deepStrictEqual(reversed, Optional.some(3));
```
- Defined in src/array/impl/array-utils-reducing-value.mts:74
max<const Ar extends readonly unknown[]>(
    array: Ar,
    comparator: (x: Ar[number], y: Ar[number]) => number,
): Ar extends readonly [unknown, unknown]
    ? Readonly<{ value: Ar<Ar>[number] }>
    : Optional<Ar[number]>
Finds the maximum 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]>
Example
```
const values = [5, 3, 9];

const largest = Arr.max(values);
const reversed = Arr.max(values, (a, b) => b - a);

assert.deepStrictEqual(largest, Optional.some(9));
assert.deepStrictEqual(reversed, Optional.some(3));
```
- Defined in src/array/impl/array-utils-reducing-value.mts:82

Function max

Type Parameters

Parameters

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

Example

Type Parameters

Parameters

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

Example

Settings

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

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