no-array-sort.md

Prefer Array#toSorted() over Array#sort()

💼 This rule is enabled in the following configs: ✅ recommended, ☑️ unopinionated.

💡 This rule is manually fixable by editor suggestions.

Prefer using Array#toSorted() over Array#sort().

Array#sort() modifies the original array, while Array#toSorted() returns a new sorted array.

Examples

// ❌
const sorted = [...array].sort();

// ✅
const sorted = array.toSorted();

// ❌
const sorted = [...iterable].sort();

// ✅
const sorted = [...iterable].toSorted();

// ❌
const sorted = [...array].sort((a, b) => a - b);

// ✅
const sorted = array.toSorted((a, b) => a - b);

Options

Type: object

allowExpressionStatement

Type: boolean
Default: true

This rule allows array.sort() to be used as an expression statement by default.
Pass allowExpressionStatement: false to forbid Array#sort() even if it's an expression statement.

/* eslint unicorn/no-array-sort: ["error", {"allowExpressionStatement": false}] */
// ❌
array.sort();

Related rules

• unicorn/no-array-reverse