SDK
SDK Javascript v5.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.

lrem #

Removes the first count occurences of elements equal to value from a list.

[Redis documentation]


lrem(key, count, value, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
countintNumber of occurences of the value to remove
valuestringValue to be removed from the list
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns an integer containing the number of removed elements.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.lrem('key', 1, 'foo', function (err, count) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.lremPromise('key', 1, 'foo')
  .then(count => {
    // resolved once the action has completed
  });

Callback response:

1