SDK
SDK Javascript v5.x
1

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.

keys #

Returns all keys matching the provided pattern.

[Redis documentation] (opens new window)


keys(pattern, [options], callback) #

Arguments Type Description
pattern string Pattern used to filter the returned key names
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Returns an array of key names matching the provided pattern.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.keys('foo*', function (err, keys) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.keysPromise('foo*')
  .then(keys => {
    // resolved once the action has completed
  });

Callback response:

Copied to clipboard!
["foo", "foobar", "foofighters"]