Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 7a47d4d

Browse files
authored
docs(options): Corrects sort example.
1 parent 561d0b9 commit 7a47d4d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The filter below is comprehensive example using all of the operators.
101101

102102

103103
### Sort
104-
This is an object where a key represents the entity property to be sorted and the value represents the direction to sort. The value should be `'asc'` to sort in ascending order and `'desc'` to sort in descending order. The properties are sorted in order of their definition in the sort option, for example, the following sort option `{ createdAt: false, id: true }` will sort by the `createdAt` property first and then the the `id` property.
104+
This is an object where a key represents the entity property to be sorted and the value represents the direction to sort. The value should be `'asc'` to sort in ascending order and `'desc'` to sort in descending order. The properties are sorted in order of their definition in the sort option, for example, the following sort option `{ createdAt: 'desc', id: 'asc' }` will sort by the `createdAt` property first and then the the `id` property.
105105

106106
This package contains the [TypeScript Sort type definition](../src/types/Sort.ts). It also contains [constants for `'asc'` and `'desc'`](../src/types/SortOrder.ts) that should always be used to avoid breaking changes in the future.
107107

0 commit comments

Comments
 (0)