Function _thenBy

_thenBy<T, TCmp>(
src: OrderedIterable<T>,
selector: (x: T) => TCmp,
): OrderedIterable<T>

Adds a secondary ascending sort key to an OrderedIterable.

Type Parameters

T
Element type contained in the ordered iterable.
TCmp
Key type produced by the selector.

Parameters

src: OrderedIterable<T>
Ordered iterable produced by _orderBy or another thenBy.
selector: (x: T) => TCmp
Selector that derives the additional key used to break ties.

Returns OrderedIterable<T>

An OrderedIterable extended with the extra ascending key.

Throws

Error Rethrows any error thrown by selector.

Example

const items = [
  { category: "fruit", name: "banana" },
  { category: "vegetable", name: "okra" },
  { category: "fruit", name: "apple" },
];
const ordered = _orderBy(items, (item) => item.category);
const sorted = [..._thenBy(ordered, (item) => item.name)];
console.log(sorted);
// [
//   { category: "fruit", name: "apple" },
//   { category: "fruit", name: "banana" },
//   { category: "vegetable", name: "okra" },
// ]

or using the curried version:

const sorted = [
  ...pipeInto(
    [
      { category: "fruit", name: "banana" },
      { category: "vegetable", name: "okra" },
      { category: "fruit", name: "apple" },
    ],
    orderBy((item) => item.category),
    thenBy((item) => item.name)
  ),
];
console.log(sorted);
// [
//   { category: "fruit", name: "apple" },
//   { category: "fruit", name: "banana" },
//   { category: "vegetable", name: "okra" },
// ]