Function: max()

max(iterable: IterableResolvable<NumberResolvable>): number | null

Consumes the iterable and returns the highest number element. If the iterable is empty, or contains only non-number values, it returns null.

Parameters

Parameter	Type	Description
`iterable`	`IterableResolvable`<`NumberResolvable`>	An iterator of number values to determine the maximum value of.

number | null

The maximum value in the input iterator, or null if the iterator is empty or contains only non-number values.

import { max } from '@sapphire/iterator-utilities';

const iterable = [1, 2, 3, 4, 5];
console.log(max(iterable));
// Output: 5

This function consumes the entire iterator.