Skip to content
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

Jump to bottom

Fix Cache Invalidation example in README #232

Merged
merged 1 commit into from Dec 23, 2023
Merged

Fix Cache Invalidation example in README #232

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Expand Up @@ -198,11 +198,11 @@ cacheManager := cache.New[string](rueidis_store.NewRueidis(
store.WithClientSideCaching(15*time.Second)),
)

if err = cacheManager.Set(context.Background(), "my-key", "my-value"); err != nil {
if err = cacheManager.Set(ctx, "my-key", "my-value"); err != nil {
panic(err)
}

value, err := cacheManager.Get(context.Background(), "my-key")
value, err := cacheManager.Get(ctx, "my-key")
if err != nil {
log.Fatalf("Failed to get the value from the redis cache with key '%s': %v", "my-key", err)
}
Expand Down Expand Up @@ -432,15 +432,19 @@ if err != nil {
}
```

Mix this with expiration times on your caches to have a fine tuned control on how your data are cached.
Mix this with expiration times on your caches to have a fine-tuned control on how your data are cached.

```go
package main

import (
"fmt"
"log"
"time"

"github.com/eko/gocache/lib/v4/cache"
"github.com/eko/gocache/lib/v4/store"
"github.com/redis/go-redis/v9"
)

func main() {
Expand All @@ -449,18 +453,20 @@ func main() {
}), nil)

cacheManager := cache.New[string](redisStore)
err := cacheManager.Set("my-key", "my-value", store.WithExpiration(15*time.Second))
err := cacheManager.Set(ctx, "my-key", "my-value", store.WithExpiration(15*time.Second))
if err != nil {
panic(err)
}

value, err := cacheManager.Get(ctx, "my-key")
key := "my-key"
value, err := cacheManager.Get(ctx, key)
if err != nil {
log.Fatalf("unable to get cache key '%s' from the cache: %v", err)
log.Fatalf("unable to get cache key '%s' from the cache: %v", key, err)
}

fmt.Printf("%#+v\n", value)
}

```

### Write your own custom cache
Expand Down Expand Up @@ -525,7 +531,7 @@ type CacheKeyGenerator interface {

## Run tests

To generate mocks usng mockgen library, run:
To generate mocks using mockgen library, run:

```bash
$ make mocks
Expand Down