Skip to main content

min_by

Note

This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information.

Returns the smallest element of the given Traversable, or null if the Traversable is empty

namespace HH\Lib\Math;

function min_by<T>(
Traversable<T> $traversable,
(function(T): num) $num_func,
): ?T;

The value for comparison is determined by the given function. In the case of duplicate numeric keys, later values overwrite previous ones.

For numeric elements, see Math\min().

Parameters

Returns

  • ?T