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.exists(keys)

Open source

Client.exists(keys)

Returns the number of key arguments that exist. Note that if the same existing key is mentioned in the argument multiple times, it will be counted multiple times.

Parameters

Parameter	Type	Description
`keys`	string[]	the keys to check the existence of.

Returns

Type	Resolves with	Rejected when
`Promise<number>`	On success, the promise resolves with the `number` of keys that exist from those specified as arguments.

Example

import redis from 'k6/experimental/redis';

// Instantiate a new redis client
const redisClient = new redis.Client('redis://localhost:6379');

export default async function () {
  let exists = await redisClient.exists('mykey');
  if (exists === true) {
    throw new Error('mykey should not exist');
  }

  await redisClient.set('mykey', 'myvalue', 0);

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

  await redisClient.del('mykey');
}