sort #

Sorts and returns elements contained in a list, a set of unique values or a sorted set. By default, sorting is numeric and elements are compared by their value interpreted as double precision floating point number.

While Kuzzle's API supports the "store" option for this command, Kuzzle SDK methods do not. To sort and store in the same process, use the [query method](/sdk/js/5/core-classes/kuzzle/query)

[Redis documentation]

sort(key, [options], callback) #

Arguments	Type	Description
`key`	string	Key identifier
`options`	JSON Object	Optional parameters
`callback`	function	Callback

Options #

Option	Type	Description	Default
`alpha`	boolean	Perform an alphanumerical sort instead of a numeric one	`false`
`by`	string	Instead of sorting the values stored at `key`, use them to complete the provided key pattern, and return the sorted list of values stored in those keys.	`null`
`direction`	string	Sort in ascendant (`ASC`) or descendant (`DESC`) order	`ASC`
`get`	array	Sort the values stored at `key` but, instead of returning these directly, return the values contained in external keys, using the provided array of patterns completed by the sorted values	`null`
`limit`	array	Limit the result set to a range of matching elements (similar to SELECT LIMIT offset, count in SQL). Format: `[<offset(int)>, <count(int)>]`	`null`
`queuable`	boolean	Make this request queuable or not	`true`

Callback Response #

Returns an array of sorted values.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.sort('key', function (err, values) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.sortPromise('key')
  .then(values => {
    // resolved once the action has completed
  });

Callback response:

["sorted element1", "sorted element2", "..."]

Edit this page on Github