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.spop(key)

Removes and returns a random element from the set value stored at key.

Parameters

ParameterTypeDescription
keystringkey holding the set to get a random member of.

Returns

TypeResolves withRejected when
Promise<string>On success, the promise resolves to the returned set member.If the set does not exist, 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.sadd('myset', 'foo');
  await redisClient.sadd('myset', 'bar');
  await redisClient.spop('myset', 'foo');
  const members = await redisClient.smembers('myset');
  if (members.length !== 1) {
    throw new Error('sismember should have length 1');
  }
}