setnx #

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

Arguments #

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
`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 a boolean telling if the operation succeeded or not.

Usage #

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

Edit this page on Github