Skip to content

docs(caching): add error event listener example for keyv redis store #3683

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
kamilmysliwiec merged 2 commits into from
Oct 31, 2026
Merged

docs(caching): add error event listener example for keyv redis store #3683

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c2831f
docs(caching): add error event handler example for keyv redis store
helmipradita Oct 31, 2026
e1441c8
docs(caching): create the redis store inside the factory
kamilmysliwiec Oct 31, 2026
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
7 changes: 6 additions & 1 deletion content/data/caching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,12 +245,15 @@ import { KeyvCacheableMemory } from 'cacheable';
imports: [
CacheModule.registerAsync({
useFactory: async () => {
const redisStore = createKeyv('redis://localhost:6379');
redisStore.on('error', (err) => console.error('Redis error:', err));

return {
stores: [
new Keyv({
store: new KeyvCacheableMemory({ ttl: 60000, lruSize: 5000 }),
}),
createKeyv('redis://localhost:6379'),
redisStore,
],
};
},
Expand All @@ -263,6 +266,8 @@ export class AppModule {}

This example registers two stores: `CacheableMemory` and a Redis store. `CacheableMemory` is an in-memory store created with the `KeyvCacheableMemory` storage adapter, while the Redis store is created with the `createKeyv()` helper from `@keyv/redis`. The `stores` array specifies the stores you want to use. The first store in the array is the default store, and the rest are fallback stores.

> warning **Warning** Always attach an `'error'` listener to the Redis store, as shown above. When the Redis connection drops, the store emits an `'error'` event, and Keyv throws if nothing listens for it, which can crash your application.

See the [Keyv documentation](https://keyv.org/docs/) for more information on the available stores.

#### Async configuration
Expand Down
Loading