ICache.purge() method
Deletes every key matching the given wildcard mask.
Signature:
purge(keyMask: string): Promise<boolean>;Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
keyMask |
string |
wildcard mask matched against fully qualified key names |
Returns:
Promise<boolean>
whether the purge ran
Remarks
The mask is not automatically scoped to this cache — callers must include the namespace themselves (<prefix>:<name>:...). A broad mask such as '*' will delete unrelated data, including message-queue keys.
Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.