Menu

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.

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/experimental/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');
}