max (BigInt)

配列の中で最も大きいBigIntを返します。

const largest = max(numbers);

INFO

この関数は、他の数値型の類似関数との潜在的な競合を避けるため、es-toolkit/bigintから独占的に利用できます。

使用法

max(nums)

複数のBigIntの中で最も大きい値を求めたい場合は max を使用してください。Math.max はBigIntをまったく受け取れないため、比較にはこの関数を使用します。

import { max } from 'es-toolkit/bigint';

const largest = max([1n, 5n, 3n]);
console.log(largest); // 5n

// 負の値でも動作します
console.log(max([-5n, -1n, -3n])); // -1n

BigIntは正確に比較されるため、numberでは同じ値に丸められてしまう値も区別されたままになります。

import { max } from 'es-toolkit/bigint';

// `number`では、どちらも9007199254740992になります
console.log(max([9007199254740992n, 9007199254740993n])); // 9007199254740993n

BigIntにはNaNも-Infinityもないため、「最大値がない」ことを表すBigIntは存在しません。そのため、空配列は代替値を返す代わりにエラーをスローします。

import { max } from 'es-toolkit/bigint';

max([]); // RangeError: Cannot find the maximum of an empty array.

パラメータ

• nums (readonly bigint[]): 探索するBigIntの配列です。

戻り値

(bigint): 配列の中で最も大きいBigIntを返します。

エラー

配列が空の場合、RangeErrorをスローします。