bitop #

Performs a bitwise operation between multiple keys (containing string values) and stores the result in the destination key.

[Redis documentation]

Arguments #

bitop(key, operation, keys, [options]);

Arguments	Type	Description
`key`	string	Key
`operation`	string	The bitwise operand to use to combine keys. Allowed values: `AND`, `NOT`, `OR`, `XOR`
`keys`	string[]	The list of keys to combine
`options`	object	Optional query arguments

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 the new destination key length.

Usage #

try {
  await kuzzle.ms.set('key1', 'foobar');
  await kuzzle.ms.set('key2', 'abcdef');
  await kuzzle.ms.bitop('dest', 'AND', ['key1', 'key2']);
  // Prints: `bc`ab
  console.log(await kuzzle.ms.get('dest'));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github