lpop

Removes and returns the first element of a list.

[Redis documentation]

Arguments

Copied to clipboard!
lpop(key, [options]);

Arguments Type Description
key
string
List key
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 value extracted from the list.

Usage

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

  // Prints: foo
  console.log(await kuzzle.ms.lpop('listfoo'));

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