orderBy

여러 기준과 정렬 방향에 따라 객체 배열을 정렬한 새 배열을 반환해요.

const sorted = orderBy(arr, criteria, orders);

레퍼런스

orderBy(arr, criteria, orders)

객체 배열을 여러 조건으로 복합 정렬하고 싶을 때 orderBy를 사용하세요. 각 조건마다 오름차순이나 내림차순을 지정할 수 있고, 앞의 조건에서 같은 값이면 다음 조건으로 정렬해요.

import { orderBy } from 'es-toolkit/array';

// 여러 기준으로 사용자 배열을 정렬해요.
const users = [
  { user: 'fred', age: 48 },
  { user: 'barney', age: 34 },
  { user: 'fred', age: 40 },
  { user: 'barney', age: 36 },
];

orderBy(users, [obj => obj.user, 'age'], ['asc', 'desc']);
// Returns:
// [
//   { user: 'barney', age: 36 },
//   { user: 'barney', age: 34 },
//   { user: 'fred', age: 48 },
//   { user: 'fred', age: 40 }
// ]

// 속성 이름과 함수를 섞어서 사용할 수 있어요.
const products = [
  { name: 'Apple', category: 'fruit', price: 1.5 },
  { name: 'Banana', category: 'fruit', price: 0.8 },
  { name: 'Broccoli', category: 'vegetable', price: 2.0 },
];

orderBy(products, ['category', product => product.name.length], ['asc', 'desc']);
// Returns: category로 먼저 정렬하고, 같은 category 내에서는 이름 길이 내림차순으로 정렬

정렬 방향의 개수가 조건보다 적으면 마지막 방향을 반복 사용해요.

import { orderBy } from 'es-toolkit/array';

const data = [
  { a: 1, b: 1, c: 1 },
  { a: 1, b: 2, c: 2 },
  { a: 2, b: 1, c: 1 },
];

orderBy(data, ['a', 'b', 'c'], ['asc', 'desc']);
// 'a'는 오름차순, 'b'와 'c'는 내림차순으로 정렬돼요.

파라미터

• arr (T[]): 정렬할 객체 배열이에요.
• criteria (Array<((item: T) => unknown) | keyof T>): 정렬할 기준들이에요. 객체의 속성 이름이나 값을 반환하는 함수를 사용할 수 있어요.
• orders (Array<'asc' | 'desc'>): 각 기준에 대한 정렬 방향 배열이에요. 'asc'는 오름차순, 'desc'는 내림차순을 의미해요.

반환 값

(T[]): 지정된 기준과 방향에 따라 정렬된 새 배열이에요.