Menu
Open source

Client.lpop(key)

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

Parameters

ParameterTypeDescription
keystringkey holding the list to left pop from.

Returns

TypeResolves withRejected 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

JavaScript
import redis from 'k6/experimental/redis';

// Instantiate a new redis client
const redisClient = new redis.Client('redis://localhost:6379');

export default async function () {
  await redisClient.lpush('mylist', 'first');
  await redisClient.rpush('mylist', 'second');

  const item = await redisClient.lpop('mylist');
  await redisClient.rpush('mylist', item);
  await redisClient.rpop('mylist');
}