Repository navigation
Conversation
- NewRedisCache and NewGORMCache take a config struct, not positional args - Cache[T].Set has no ttl parameter; expiry belongs to the Client or the backend config - missing keys are signalled with *cachex.ErrKeyNotFound, checked via IsErrKeyNotFound - the string JSON transform is StringJSONTransform[T], JSONTransform takes Cache[[]byte]
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
All documentation changes accurately reflect the current implementation.
Review effort: Balanced
Findings: None
What changed in this PR
Updates English and Chinese README examples to match the current Cachex API.
Changes:
- Corrects backend constructors and
Cache.Set. - Updates not-found error handling and JSON transformation examples.
- Adds GORM migration examples.
| File | Description |
|---|---|
README.md |
Aligns English examples with current APIs. |
README_ZH.md |
Mirrors corrections in Chinese documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several README snippets (both English and Chinese) no longer compile against the current code:
NewRedisCache[T](client, prefix, ttl)NewRedisCache[T](&RedisCacheConfig{Client, KeyPrefix, TTL})NewGORMCache(db, table, ttl)NewGORMCache[T](&GORMCacheConfig{DB, TableName, KeyPrefix}), no TTLCache[T].Set(ctx, key, value, ttl)Set(ctx, key, value)cachex.ErrKeyNotFoundErrKeyNotFoundis a struct type: return&cachex.ErrKeyNotFound{}, check withIsErrKeyNotFoundJSONTransform[string, *User](stringCache)StringJSONTransform[*User](stringCache)(JSONTransform[T]takesCache[[]byte])This PR only touches
README.mdandREADME_ZH.md. I compiled the corrected snippets in a throwaway test before committing.