This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/x/redisbreadcrumb arrow Clientbreadcrumb arrow Client.lrange(key, start, stop)
Open source

Client.lrange(key, start, stop)

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

ParameterTypeDescription
keystringkey holding the list to get the range of.
startnumberindex of the first element to return.
stopnumberindex of the last element to return.

Returns

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

Example

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

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

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

  const item = redisClient.lindex('mylist', 0);
  if (item !== 'first') {
    throw new Error('lindex operation should have returned first');
  }

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