SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

sscan #

Identical to scan, except that sscan iterates the members held by a set of unique values.

[Redis documentation]

sscan(key, cursor, [options], callback) #

Arguments Type Description
key string Key identifier
cursor int Page number (iteration starts with a cursor value of 0, and ends when the next cursor position is 0)
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
count int Return the approximate count number of items per result page 10
match string Search only for member values matching the provided pattern *
queuable boolean Make this request queuable or not true

Callback Response #

Returns a JSON array containing 2 entries:

  • the cursor position for the next page of results (a next position of 0 indicates the end of the scan)
  • an array of members

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.sscan('key', 0, function (err, page) {
  // callback called once the action has completed
// Using promises (NodeJS only)
kuzzle.memoryStorage.sscanPromise('key', 0)
  .then(page => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!
  "cursor": 18,
  "values": ["member1", "member2", "..."]