es-toolkit/dist/compat/array/sortedIndex.d.mts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

//#region src/compat/array/sortedIndex.d.ts
/**
 * Uses a binary search to determine the lowest index at which `value`
 * should be inserted into `array` in order to maintain its sort order.
 *
 * @category Array
 * @param array The sorted array to inspect.
 * @param value The value to evaluate.
 * @returns Returns the index at which `value` should be inserted
 *  into `array`.
 * @example
 * sortedIndex([30, 50], 40)
 * // => 1
 */
declare function sortedIndex<T>(array: ArrayLike<T> | null | undefined, value: T): number;
/**
 * Uses a binary search to determine the lowest index at which `value`
 * should be inserted into `array` in order to maintain its sort order.
 *
 * @category Array
 * @param array The sorted array to inspect.
 * @param value The value to evaluate.
 * @returns Returns the index at which `value` should be inserted
 *  into `array`.
 * @example
 * sortedIndex([30, 50], 40)
 * // => 1
 */
declare function sortedIndex<T>(array: ArrayLike<T> | null | undefined, value: T): number;
//#endregion
export { sortedIndex };