@thi.ng/arrays/is-sorted.d.ts

Array / Arraylike utilities

import type { Comparator } from "@thi.ng/api";
/**
 * Returns true if the given array and its elements in the selected index range
 * (entire array, by default) are in the order defined by the given comparator
 * ([`compare`](https://docs.thi.ng/umbrella/compare/functions/compare.html) by
 * default).
 *
 * @remarks
 * Always returns true, if effective index range (or array length) has less than
 * two elements. No bounds checking.
 *
 * @example
 * ```ts tangle:../export/is-sorted.ts
 * import { isSorted } from "@thi.ng/arrays";
 *
 * console.log(
 *   isSorted([3, 2, 1])
 * );
 * // false
 *
 * // w/ custom comparator
 * console.log(
 *   isSorted([3, 2, 1], (a, b) => b - a)
 * );
 * // true
 * ```
 *
 * @param arr - array
 * @param cmp - comparator
 * @param start - start index
 * @param end - end index
 */
export declare const isSorted: <T>(arr: ArrayLike<T>, cmp?: Comparator<T>, start?: number, end?: number) => boolean;
//# sourceMappingURL=is-sorted.d.ts.map