method

RedisClient.unlink

...keys: KeyLike[]

): Promise<number>;

Asynchronously delete one or more keys

This command is very similar to DEL: it removes the specified keys. Just like DEL a key is ignored if it does not exist. However, the command performs the actual memory reclaiming in a different thread, so it is not blocking, while DEL is. This is particularly useful when deleting large values or large numbers of keys.

@param keys

The keys to delete

@returns

Promise that resolves with the number of keys that were unlinked

await redis.set("key1", "Hello");
await redis.set("key2", "World");
const count = await redis.unlink("key1", "key2", "key3");
console.log(count); // 2

Referenced types

type KeyLike = string | ArrayBufferView | Blob