Skip to content

Commit 12edc61

Browse files
committed
update README.md regarding types of sortBy and sortOrder
1 parent 150a94b commit 12edc61

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,20 @@ Set page number, page size and sorting parameters. It's possible to order result
143143
- relevance (descending)
144144
- date (ascending or descending)
145145
- custom field value (ascending or descending. E.g. *custom_fields.price*)
146+
147+
Type of sortBy and sortOrder: `string` or `array`. They must have the same type, in case type is array, sortBy and sortOrder must have the same size.
148+
For example:
149+
```js
150+
sortBy = 'date';
151+
sortOrder = 'desc';
152+
153+
or
154+
155+
sortBy = ['date', 'custom_fields.price'];
156+
sortOrder = ['desc', 'asc'];
157+
```
158+
159+
146160
```js
147161
// Defaults: page "1", pageSize "10", sortBy "relevance", sortOrder "desc"
148162
client.setPaging(page, pageSize, sortBy, sortOrder);

0 commit comments

Comments
 (0)