js-function-lib/module/min.d.ts

JavaScript function library

/**
 * 计算 array 中的最小值。 如果 array 是 空的或者假值将会返回 undefined
 *
 * @param {Array<number>} array 要迭代的数组
 * @returns {(number | undefined)} 返回最小的值
 * @version 1.1.5
 * @example
 *
 * min([1, 2, 3]);
 * // => 1
 */
declare function min(array: Array<number>): number | undefined;
/**
 * 计算 array 中的最小值。 如果 array 是 空的或者假值将会返回 undefined
 *
 * @param {Array<any>} array 要迭代的数组
 * @param {string} iteratee 调用每个元素的迭代函数
 * @returns {(object | undefined)} 返回最小的值
 * @version 1.1.5
 * @example
 *
 * min([{id: 1}, {id: 2}, {id: 3}], 'id');
 * // => {id: 1}
 */
declare function min(array: Array<any>, iteratee: string): object | undefined;
/**
 * 计算 array 中的最小值。 如果 array 是 空的或者假值将会返回 undefined
 *
 * @param {Array<any>} array 要迭代的数组
 * @param {Function} iteratee 调用每个元素的迭代函数
 * @returns {(object | undefined)} 返回最小的值
 * @version 1.1.5
 * @example
 *
 * min([{ id: 1 }, { id: 2 }, { id: 3 }], (v) => v.id);
 * // => {id: 1}
 */
declare function min(array: Array<any>, iteratee: Function): object | undefined;
export default min;
//# sourceMappingURL=min.d.ts.map