Menu
Grafana k6 JavaScript API k6/experimental redis Client Client.lpop(key)
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';

// 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 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');
}