Back to Functions

max

math

Computes the maximum value of array.

Installation

Import
import { max } from '@tulx/utils';

Source Code

Implementation
/**
 * Computes the maximum value of array.
 *
 * @param array - The array to iterate over.
 * @returns Returns the maximum value.
 *
 * @example
 * ```ts
 * max([4, 2, 8, 6]); // 8
 * max([]); // undefined
 * ```
 */
export function max(array: readonly number[]): number | undefined {
  if (array.length === 0) {
    return undefined;
  }
  return Math.max(...array);
}

Example

import { max } from '@tulx/utils';

max([4, 2, 8, 6]); // 8
max([]); // undefined

Related Functions