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.

rpushx #

Appends a value at the end of a list, only if the destination key already exists, and if it holds a list.

[Redis documentation]

Arguments #

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

Arguments Type Description
key
string
List key
value
string
Value to append
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 updated list length.

Usage #

Copied to clipboard!
try {
  // Prints: 0
  // ("listfoo" does not exist: the operation fails)
  console.log(await kuzzle.ms.rpushx('listfoo', 'qux'));
  await kuzzle.ms.rpush('listfoo', ['foo', 'bar', 'baz']);
  // Prints: 4
  console.log(await kuzzle.ms.rpushx('listfoo', 'qux'));
} catch (error) {
  console.error(error.message);
}