Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(cache): add note on cache key normalization and escapeKey usage #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atinux merged 1 commit into from
Jul 17, 2025
Merged

docs(cache): add note on cache key normalization and escapeKey usage #632

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/content/docs/2.features/cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,51 @@ await useStorage('cache').clear('nitro:handlers')
Read more about Nitro Cache.
::

### Normalizing Cache Keys

::important
**Cache keys are automatically normalized** using an internal utility that removes non-alphanumeric characters such as `/` and `-`. This behavior helps ensure compatibility across various storage backends (e.g., `file systems`, `key-value` stores) that might have restrictions on characters in `keys`, and also prevents potential path traversal vulnerabilities.
::

For example:

```ts
getKey: () => '/api/products/sale-items'
```

Would generate a key like:

```ts
api/productssaleitems.json
```

This behavior may result in keys that look different from the original route or identifier.

::tip
To manually reproduce the same normalized key pattern used by Nitro (e.g., when invalidating cache entries), you can use the `escapeKey` utility function provided below:
::

```ts
function escapeKey(key: string | string[]) {
return String(key).replace(/\W/g, "");
}
```

It's recommended to use `escapeKey()` when invalidating manually using route paths or identifiers to ensure consistency with Nitro's internal key generation.

For example, if your `getKey` function is:

```ts
getKey: (id: string) => `product/${id}/details`
```

And you want to invalidate `product/123/details`, you would do:

```ts
const normalizedKey = escapeKey('product/123/details')
await useStorage('cache').removeItem(`nitro:functions:getProductDetails:${normalizedKey}.json`)
```

## Cache Expiration

As NuxtHub leverages Cloudflare Workers KV to store your cache entries, we leverage the [`expiration` property](https://developers.cloudflare.com/kv/api/write-key-value-pairs/#expiring-keys) of the KV binding to handle the cache expiration.
Expand Down