Skip to main content

Description

Removes the specified keys. A key is ignored if it does not exist.

Method Signature

del(...keys: string[]): Promise<number>

Parameters

keys
string[]
required
One or more keys to delete

Return Value

result
number
The number of keys that were removed

Examples

Delete a single key

await redis.set("mykey", "value");
const deleted = await redis.del("mykey");
console.log(deleted); // 1

Delete multiple keys

await redis.set("key1", "value1");
await redis.set("key2", "value2");
await redis.set("key3", "value3");

const deleted = await redis.del("key1", "key2", "key3");
console.log(deleted); // 3

Delete non-existent keys

const deleted = await redis.del("nonexistent");
console.log(deleted); // 0

See Also

  • exists - Check if keys exist