- Notifications
You must be signed in to change notification settings - Fork1.7k
Clarify CacheExtensions.TryGetValue<TItem> documentation for type mismatch behavior#11959
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
Copilot wants to merge2 commits intomainChoose a base branch fromcopilot/fix-cache-extensions-behavior
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+8 −6
Conversation
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
Co-authored-by: jozkee <16040868+jozkee@users.noreply.github.com>
CopilotAI changed the title[WIP] Fix ambiguity in CacheExtensions.TryGetValue<T> behaviorClarify CacheExtensions.TryGetValue<TItem> documentation for type mismatch behaviorOct 23, 2025
Copilot finished work on behalf ofjozkeeOctober 23, 2025 19:48
gewarren approved these changesOct 28, 2025
Contributor
Tagging subscribers to this area: @dotnet/area-extensions-caching |
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
Summary
Fixes the documentation ambiguity in
CacheExtensions.TryGetValue<TItem>andCacheExtensions.Get<TItem>to clarify that these methods handle type mismatches by returningfalse/default(TItem), not just when keys are absent.Problem
The existing documentation stated that
TryGetValue<TItem>returns "trueif the key was found;falseotherwise", which was ambiguous and misleading. In reality, the method returnsfalsein two distinct scenarios:TItemThis caused confusion, especially for instrumented cache decorators that track hit/miss metrics:
Changes
TryGetValue<TItem> Method
TItemtrueif the key was found and the stored value can be cast toTItem;falseotherwise"valueis set todefault(TItem)for both missing keys and type mismatchesfalsefor both missing keys and type mismatchesIMemoryCache.TryGetValuemethod, which returnstrueif the key exists regardless of typeGet<TItem> Method
TItem"default(TItem)is returned for both missing keys and type mismatchesResolution
Addresses #38969 by providing clear documentation that helps developers understand the type-checking behavior and guides them toward appropriate alternatives when they need to distinguish between "key not found" and "key found with incompatible type" scenarios.
Original prompt
Fixes#11958
✨ Let Copilot coding agentset things up for you — coding agent works faster and does higher quality work when set up for your repo.