Core 2.x

lrem

Removes the first occurences of an element from a list.

[Redis documentation]

Arguments

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

Arguments Type Description
key
string
List key
count
integer
Number of the first found occurences to remove
value
string
Value to remove
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 number of removed elements.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.rpush('listfoo', ['foo', 'bar', 'foo', 'baz', 'foo']);
  // Prints: 2
  console.log(await kuzzle.ms.lrem('listfoo', 2, 'foo'));
  // Prints: [ 'bar', 'baz', 'foo' ]
  console.log(await kuzzle.ms.lrange('listfoo', 0, -1));
} catch (error) {
  console.error(error.message);
}