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.

Documentation

Client.getSet(key, value)

Open source

Client.getSet(key, value)

Atomically sets key to value and returns the value previously stored at key.

Parameters

Parameter	Type	Description
`key`	string	the key to get and set
`value`	string, number, or boolean	the value to set

Returns

Type	Resolves with	Rejected when
`Promise<string>`	On success, the promise resolves with the old value stored at `key`.	If `key` does not exist, or does not hold a string value, the promise is rejected with an error.

Example

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', 'oldvalue', 0);
  await redisClient.getSet('mykey', 'newvalue');
  await redisClient.getDel('mykey');
}