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.

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.

[Redis documentation]


lpush(key, values, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
valuesarrayValues to add at the beginning of 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 updated number of items in the list.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.lpush('key', ['foo', 'bar', 'baz'], function (err, count) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.lpushPromise('key', ['foo', 'bar', 'baz'])
  .then(count => {
    // resolved once the action has completed
  });

Callback response:

6