Client-lpop.md

title	excerpt
Client.lpop(key)	Removes and returns the first element of the list stored at `key`.

Removes and returns the first element of the list stored at key.

Parameters

Parameter	Type	Description
key	string	key holding the list to left pop from.

Returns

Type	Resolves with	Rejected when
Promise<string>	On success, the promise resolves with the value of the first element.	If the list does not exist, the promise is rejected with an error.

Example

import redis from 'k6/experimental/redis';

// Get the redis instance(s) address and password from the environment
const redis_addrs = __ENV.REDIS_ADDRS || '';
const redis_password = __ENV.REDIS_PASSWORD || '';

// Instantiate a new redis client
const redisClient = new redis.Client({
  addrs: redis_addrs.split(',') || new Array('localhost:6379'), // in the form of 'host:port', separated by commas
  password: redis_password,
});

export default function () {
  redisClient
    .lpush('mylist', 'first')
    .then((_) => redisClient.rpush('mylist', 'second'))
    .then((_) => redisClient.lpop('mylist'))
    .then((item) => redisClient.rpush('mylist', item))
    .then((_) => redisClient.rpop('mylist'));
}