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.

getset #

Sets a new value for a key, and returns its previously stored value.

[Redis documentation]

Arguments #

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

Arguments Type Description
key
string
Key
value
*
New key 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 the previously set value, or null if the key didn't exist prior to this operation.

Usage #

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