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.

msetnx #

Sets the provided keys to their respective values, only if they do not exist. If a key exists, then the whole operation is aborted and no key is set.

[Redis documentation]

Arguments #

Copied to clipboard!
msetnx(entries, [options]);

Arguments Type Description
entries
object[]
List of key-value pairs to set
options
object
Optional query arguments

entries #

The entries argument is an array of objects. Each object is a key-value pair, defined with the following properties:

Property Type Description
key
string
Key
value
*
Value

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

Resolve #

Resolves to a boolean telling whether the keys have been set or not.

Usage #

Copied to clipboard!
const entries = [
  { key: 'hello', value: 'world' },
  { key: 'foo', value: 'bar' }
];
try {
  await kuzzle.ms.set('foo', 'bar');
  // Prints: false
  // (the entire operation aborted)
  console.log(await kuzzle.ms.msetnx(entries));
  await kuzzle.ms.del('foo');
  // Prints: true
  console.log(await kuzzle.ms.msetnx(entries));
} catch (error) {
  console.error(error.message);
}