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.

lpop #

Removes and returns the first element of a list.

[Redis documentation]


lpop(key, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns the value of the removed item.

Usage #

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

Callback response:

"foo"