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.set(key, value, expiration)
Open source

Client.set(key, value, expiration)

Set the value of a key, with a time to live equal to the expiration time parameter (in seconds). If the key already holds a value, it is overwritten.

Parameters

ParameterTypeDescription
keystringthe key to set
valuestring, number, or booleanthe value to set
expirationintegerthe time to live in seconds. the 0 value indicates no expiration.

Returns

TypeResolves withRejected when
Promise<string>On success, the promise resolves with ‘OK’.If the provided value is not of a supported type, 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.set('mykey', 'myvalue', 0);

  const exists = await redisClient.exists('mykey');
  if (exists === false) {
    throw new Error('mykey should exist');
  }

  const value = await redisClient.get('mykey');
  console.log(`set key 'mykey' to value: ${value}`);

  await redisClient.del('mykey');
}