@technobuddha/library/dist/mode.d.ts

A large library of useful functions

/**
 * Returns the mode (the most frequently occurring element) of the given array.
 * If multiple elements have the same highest frequency, the first encountered is returned.
 * Returns `undefined` if the array is empty.
 * @typeParam T - The type of elements in the input array.
 * @param array - The array of elements to find the mode of.
 * @returns The mode of the array, or `undefined` if the array is empty.
 * @example
 * ```typescript
 * mode([1, 2, 2, 3, 3, 3, 4]); // 3
 * mode(['a', 'b', 'b', 'a', 'c']); // 'a'
 * mode([true, false, false, true, true]); // true
 * mode([]); // undefined
 * ```
 * @group Math
 * @category Statistics
 */
export declare function mode<T>(array: T[]): T | undefined;