keys #

Returns all keys matching the provided pattern.

Arguments #

keys(pattern, [options]);

Arguments	Type	Description
`pattern`	string	Match pattern
	`options`	object

options #

The options arguments can contain the following option properties:

Property	Type (default)	Description
`queuable`	boolean (true)	If `true`, queues the request during downtime, until connected to Kuzzle again
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

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);
}

Edit this page on Github