Make sorting configuration an array instead of an object

[vasilii-kovalev]

Current approach

users.updateMany((q) => q.where({ name: (name) => name.startsWith('J') }), {
  data(user) {
    user.name = user.name.toUpperCase(),
  },
  orderBy: {
    name: 'asc',
    id: 'desc',
  },
})

Using an object instead of an array to configure the sorting makes the order/priority less obvious. Also, some people may prefer sorting the keys in the objects (using an ESLint plugin or manually), which would affect how the data is sorted.

Proposed approaches

Single array of objects

users.updateMany((q) => q.where({ name: (name) => name.startsWith('J') }), {
  data(user) {
    user.name = user.name.toUpperCase(),
  },
  orderBy: [
    {
      key: 'name',
      direction: 'asc',
    },
    {
      key: 'id',
      direction: 'desc',
    },
  ],
})

Separated arrays of keys and directions

Like in es-toolkit or Lodash.

users.updateMany((q) => q.where({ name: (name) => name.startsWith('J') }), {
  data(user) {
    user.name = user.name.toUpperCase(),
  },
  orderBy: [
    [
      'name',
      'id',
    ],
    [
      'asc',
      'desc',
    ],
  ],
})

[vasilii-kovalev]

Also, there is a typo in the example:

data(user) {
  user.name = user.name.toUpperCase(),
  -----------------------------------^ Should be ';' or nothing
},

[kettanaito]

This is a great suggestion, @vasilii-kovalev. I've overlooked that Prisma also supported an array of sortBy values. Will add this one.

[kettanaito]

I'm going to use Prisma's Sorting as the expectation reference here:

users.findMany(undefined, {
  orderBy: [{ age: 'asc' }, { name: 'desc' }]
})

• An order-sensitive list of values;
• Each item is an object of { key: SortDirtection };

This produces order-sensitive sorting where the first criteria is the primary and every subsequent one is a tiebreaker, just like it is in Prisma.

[kettanaito]

Released: v1.1.5 🎉

This has been released in v1.1.5.

• 📄 Release notes
• 📦 View on npm

Get these changes by running the following command:

npm i @msw/data@latest

---

Predictable release automation by Release.