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.hdel(key, fields)

Deletes the specified fields from the hash stored at key. The number of fields that were removed from the hash is returned on resolution (non including non existing fields).

Parameters

ParameterTypeDescription
keystringkey holding the hash to delete the fields of.
fieldsstring[]fields to delete from the hash.

Returns

TypeResolves withRejected when
Promise<number>On success, the promise resolves with the number of fields that were removed from the hash, not including specified, but non existing, fields.

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.hset('myhash', 'myfield', 'myvalue');
  await redisClient.hget('myhash', 'myfield');
  await redisClient.hdel('myhash', 'myfield');
}