How do you sort an array of objects by a given property in Typescript?

Question

Say you have an array of objects of the following type:

type Obj = {
  id: number,
  created: Date, 
  title: string
}

How would you sort by a given property without tripping up over the type system? For example:

const numberSorted = objArray.sortBy("id");
const dateSorted = objArray.sortBy("created");
const stringSorted = objArray.sortBy("title");

@GuillaumeBrunerie I've looked over the Array.prototype.sort() docs and came up with the following sort((a,b) => a[property] > b[property] ? 1 : -1). IMO, this is verbose, so I was hoping from something a little slicker. — Aetherovox
– Aetherovox, Commented Sep 27, 2022 at 12:43
I'm afraid there is no slicker way, not built-in to Javascript at least. — Guillaume Brunerie
– Guillaume Brunerie, Commented Sep 27, 2022 at 12:55
Does this answer your question? Sort an array of objects in typescript? — JAYD3V
– JAYD3V, Commented Sep 27, 2022 at 13:28

Usitha Indeewara · Accepted Answer · 2022-10-12 15:35:15Z

4

You can use Array.prototype.sort

For example:

objArray.sort((a, b) => {
    // Some code for comparison
});

Learn more about the sort function: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort

edited Oct 12, 2022 at 15:35

answered Sep 27, 2022 at 12:44

Usitha Indeewara

1,0134 gold badges15 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

zapl · Accepted Answer · 2022-09-27 19:51:05Z

You can define a function like

function sortBy<T, V>(
        array: T[],
        valueExtractor: (t: T) => V,
        comparator?: (a: V, b: V) => number) {

  // note: this is a flawed default, there should be a case for equality
  // which should result in 0 for example
  const c = comparator ?? ((a, b) => a > b ? 1 : -1) 
  return array.sort((a, b) => c(valueExtractor(a), valueExtractor(b)))
}

which then could be used like

interface Type { a: string, b: number, c: Date }
const arr: Type[] = [
  { a: '1', b: 1, c: new Date(3) },
  { a: '3', b: 2, c: new Date(2) },
  { a: '2', b: 3, c: new Date(1) },
]
const sortedA: Type[] = sortBy(arr, t => t.a)
const sortedC: Type[] = sortBy(arr, t => t.c)
// or if you need a different comparison
const sortedX = sortBy(arr, t => t.c, (a, b) => a.getDay() - b.getDay())

This also works with nested properties within objects t => t.a.b.c or for cases where you need to derive the sort key further e.g. t => t.a.toLowerCase()

Collectives™ on Stack Overflow

How do you sort an array of objects by a given property in Typescript?

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related