SDK
SDK Javascript v6.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]

Arguments #

keys(pattern, [options]);

ArgumentsTypeDescription
pattern
string
Match pattern
options
object

options #

The options arguments can contain the following option properties:

PropertyType (default)Description
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolve #

Resolves to an array of key identifiers.

Usage #

try {
  await kuzzle.ms.set('foo', 'bar');
  await kuzzle.ms.set('Suddenly', 'Bananas');
  await kuzzle.ms.set('Hello', 'World');
  // Prints: [ 'foo', 'Hello' ]
  console.log(await kuzzle.ms.keys('*o'));
} catch (error) {
  console.error(error.message);
}