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.lindex(key)
Open source

Client.lindex(key)

Returns the specified element of the list stored at key. The index is zero-based. Negative indices can be used to designate elements starting at the tail of the list.

Parameters

ParameterTypeDescription
keystringkey holding the list to get the element of.

Returns

TypeResolves withRejected when
Promise<string>On success, the promise resolves with the requested element.If the list does not exist, or the index is out of bounds, the promise is rejected with an error.

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

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