Skip to content

Commit 257e748

Browse files
author
Matt Willer
authored
Document search sort parameters (#370)
1 parent fd963e9 commit 257e748

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

lib/managers/search.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ Search.prototype = {
7878
* @param {SearchMetadataFilter[]} [options.mdfilters] - Searches for objects with a specific metadata object association. Searches with the this parameter do not require a query string
7979
* @param {int} [options.limit=30] - The number of search results to return, max 200
8080
* @param {int} [options.offset=0] - The search result at which to start the response, must be a multiple of limit
81+
* @param {string} [options.sort] - The field on which the results should be sorted, e.g. "modified_at"
82+
* @param {string} [options.direction] - The sort direction: "ASC" for ascending and "DESC" for descending
8183
* @param {APIRequest~Callback} [callback] - passed the new comment data if it was posted successfully
8284
* @returns {Promise<Object>} A promise resolving to the collection of search results
8385
*/

0 commit comments

Comments
 (0)