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.

Documentation

Client.lpush(key, values)

Open source

Client.lpush(key, values)

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

Parameters

Parameter	Type	Description
`key`	string	key holding the list to left push to.
`values`	a variadic array of strings, numbers, or booleans	values to push to the list.

Returns

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

Example

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

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