sindresorhus / is-array-sorted

Check if an Array is sorted

is-array-sorted

Check if an array is sorted

Install

$ npm install is-array-sorted

Usage

import isArraySorted from 'is-array-sorted';

isArraySorted([1, 2, 3]);
//=> true

isArraySorted([1, 3, 2]);
//=> false

isArraySorted(['a', 'b', 'c']);
//=> true

API

isArraySorted(array, options?)

Returns a boolean.

array

Type: unknown[]

The array to check.

options

Type: object

comparator

Type: Function
Default: Ascending order ((a, b) => a - b)

Same as Array#sort(comparator).

is-array-sorted's Issues

Improvement suggestion

Don't wanna go so far as to PR, but:

'use strict';
module.exports = (arr, comp) => {
	for (let i = 0; i < arr.length - 1; i++) {
		const a = arr[i];
		const b = arr[i + 1];

		if (comp ? comp(a, b) > 0 : a > b) {
			return false;
		}
	}

	return true;
};

to

'use strict';
module.exports = (arr, comp) => {
        const compare = comp
            ? (a, b) => comp(a, b) > 0
            : (a, b) => a > b;
	for (let i = 0; i < arr.length - 1; i++) {
		const a = arr[i];
		const b = arr[i + 1];

		if (compare(a, b)) {
			return false;
		}
	}

	return true;
};

doesn't have to do the comparison method ?: every iteration