lpush #

Prepends the specified values to a list.

If the key does not exist, it is created holding an empty list before performing the operation.

Arguments #

lpush(key, values, [options]);

Arguments	Type	Description
`key`	string	List key
`values`	string[]	Values 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 length of the list.

Usage #

try {
  await kuzzle.ms.rpush('listfoo', ['foobar']);
  // Prints: 3
  console.log(await kuzzle.ms.lpush('listfoo', ['World', 'Hello']));
  // Prints: [ 'Hello', 'World', 'foobar' ]
  console.log(await kuzzle.ms.lrange('listfoo', 0, -1));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github