Javascript 7.x

setnx

Sets a value on a key, only if it does not already exist.

[Redis documentation]

Arguments

Copied to clipboard!
setnx(key, value, [options]);

Arguments Type Description
key
string
Key
value
string
Value
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

Resolve

Resolves to a boolean telling if the operation succeeded or not.

Usage

Copied to clipboard!
try {
  // Prints: true
  console.log(await kuzzle.ms.setnx('foo', 'bar'));
  // Prints: false
  console.log(await kuzzle.ms.setnx('foo', 'qux'));
  // Prints: bar
  console.log(await kuzzle.ms.get('foo'));
} catch (error) {
  console.error(error.message);
}