linsert

Inserts a value in a list, either before or after a pivot value.

[Redis documentation]

Arguments

Copied to clipboard!
linsert(key, position, pivot, value, [options]);

Arguments Type Description
key
string
List key
position
string
Position relative to the pivot.
Allowed values: before, after
pivot
string
Existing list value to use as a pivot
value
string
Value to insert
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 length of the list.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.rpush('listfoo', ['foo', 'bar', 'baz']);

  await kuzzle.ms.linsert('listfoo', 'before', 'bar', 'qux');

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