Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/experimentalbreadcrumb arrow redisbreadcrumb arrow Clientbreadcrumb arrow Client.rpush(key, values)
Open source

Client.rpush(key, values)

Inserts all the specified values at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.

Parameters

ParameterTypeDescription
keystringkey holding the list to right push to.
valuesa variadic array of strings, numbers, or booleansvalues to push to the list.

Returns

TypeResolves withRejected when
Promise<number>On success, the promise resolves with the length of the list after the push operation.When key holds a value that is not a list, the promise is rejected with an error.

Example

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