sortBy | /collections/mod.ts | std@0.203.0

Module

std/collections/mod.ts>sortBy

Deno standard library

denoland/deno_std

Go to Latest

unstable

mod.ts (default module)

binary_search_node.ts

BinarySearchNode

Direction

binary_search_tree.ts

first_not_nullish_of.ts

function sortBy

import { sortBy } from "https://deno.land/std@0.203.0/collections/mod.ts";

sortBy<T>(

array: readonly T[],

selector: (el: T) => number,

options?: SortByOptions,

): T[]

Returns all elements in the given collection, sorted by their result using the given selector. The selector function is called only once for each element. Ascending or descending order can be specified.

sortBy<T>(

array: readonly T[],

selector: (el: T) => string,

options?: SortByOptions,

): T[]

sortBy<T>(

array: readonly T[],

selector: (el: T) => bigint,

options?: SortByOptions,

): T[]

sortBy<T>(

array: readonly T[],

selector: (el: T) => Date,

options?: SortByOptions,

): T[]

Examples

Example 1

import { sortBy } from "https://deno.land/std@0.203.0/collections/sort_by.ts";
import { assertEquals } from "https://deno.land/std@0.203.0/assert/assert_equals.ts";

const people = [
  { name: "Anna", age: 34 },
  { name: "Kim", age: 42 },
  { name: "John", age: 23 },
];
const sortedByAge = sortBy(people, (it) => it.age);

assertEquals(sortedByAge, [
  { name: "John", age: 23 },
  { name: "Anna", age: 34 },
  { name: "Kim", age: 42 },
]);

const sortedByAgeDesc = sortBy(people, (it) => it.age, { order: "desc" });

assertEquals(sortedByAgeDesc, [
  { name: "Kim", age: 42 },
  { name: "Anna", age: 34 },
  { name: "John", age: 23 },
]);