lpushx #

Prepends the specified value to a list, only if the key already exists and if it holds a list.

Arguments #

lpushx(key, value, [options]);

Arguments	Type	Description
`key`	string	Existing 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
`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 the updated list length.

Usage #

try {
  // Prints: 0
  console.log(await kuzzle.ms.lpushx('listfoo', 'foo'));
  // Prints: []
  console.log(await kuzzle.ms.lrange('listfoo', 0, -1));
  await kuzzle.ms.lpush('listfoo', ['bar']);
  // Prints: 2
  console.log(await kuzzle.ms.lpushx('listfoo', 'foo'));
  // Prints: [ 'foo', 'bar' ]
  console.log(await kuzzle.ms.lrange('listfoo', 0, -1));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github