Client-lrange.md

title	excerpt
Client.lrange(key, start, stop)	Returns the specified elements of the list stored at `key`.

Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes. These offsets can be negative numbers, where they indicate offsets starting at the end of the list.

Parameters

Parameter	Type	Description
key	string	key holding the list to get the range of.
start	number	index of the first element to return.
stop	number	index of the last element to return.

Returns

Type	Resolves with	Rejected when
Promise<string[]>	On success, the promise resolves with the list of elements in the specified range.

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
    .rpush('mylist', 'first')
    .then((_) => redisClient.rpush('mylist', 'second'))
    .then((_) => redisClient.rpush('mylist', 'third'))
    .then((_) => redisClient.lindex('mylist', 0))
    .then((item) => {
      if (item !== 'first') {
        throw new Error('lindex operation should have returned first');
      }

      return redisClient.lrange('mylist', 1, 2);
    });
}