querier-ts 2.7.0 → 2.7.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v2.7.1
+
+### Summary
+
+- [x] Documentation updates
+- [ ] Bug fixes
+- [ ] Code refactoring
+- [ ] New features
+- [ ] Breaking changes
+
+### New features
+
+- Update `README.md` documentation for `orderBy()` method with new overload and examples.
+
 ## v2.7.0
 
 ### Summary

package/README.md

@@ -144,23 +144,30 @@ const query = Query.from()
 
 ### Ordering results
 
-#### `orderBy(...columns)`
+#### `orderBy(...columns | (callback, order?))`
 
-Sorts the results. You can pass multiple columns.
+Sorts the results.
 
-```ts
-.orderBy('name', 'id')
-```
+- `columns`: the columns to order by.
+- `callback`: A function that maps each row to a value.
+- `order`: The order to sort in.
 
-In this example, `name` has higher priority than `id`.
+You can specify column names or a callback function to map each row to a value.
 
-You can also sort in descending order by prefixing the column with `-`:
+Examples:
 
 ```ts
-const lastId = Query.from(users)
-  .select('id')
-  .orderBy('-id')
-  .scalar();
+// Column names with ASC and DESC (-) order
+.orderBy('name', '-createdAt')
+
+// callback with ASC order by default
+.orderBy((user) => user.address.country)
+
+// callback with ASC order set explicitly
+.orderBy((user) => user.address.country, 'asc')
+
+// callback with DESC order
+.orderBy((user) => user.address.country, 'desc')
 ```
 
 ---

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "querier-ts",
   "type": "module",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "A lightweight, type-safe in-memory query engine for JavaScript and TypeScript",
   "repository": {
     "type": "git",