Skip to content

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.

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −6
Draft

Clarify CacheExtensions.TryGetValue<TItem> documentation for type mismatch behavior #11959

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc564a6
Initial plan
Copilot Oct 23, 2025
5041469
Update CacheExtensions documentation to clarify type-check behavior
Copilot Oct 23, 2025
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
14 changes: 8 additions & 6 deletions xml/Microsoft.Extensions.Caching.Memory/CacheExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" /> instance this method extends.</param>
<param name="key">The key of the value to get.</param>
<summary>
Gets the value associated with this key if present.
Gets the value associated with this key if present and castable to <typeparamref name="TItem" />.
</summary>
<returns>The value associated with this key, or <c>default(TItem)</c> if the key is not present.</returns>
<returns>The value associated with this key, or <c>default(TItem)</c> if the key is not present or the stored value can't be cast to <typeparamref name="TItem" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -595,13 +595,15 @@
<typeparam name="TItem">The type of the object to get.</typeparam>
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache" /> instance this method extends.</param>
<param name="key">The key of the value to get.</param>
<param name="value">The value associated with the given key.</param>
<param name="value">The value associated with the given key, or <c>default(TItem)</c> if the key is not found or the stored value can't be cast to <typeparamref name="TItem" />.</param>
<summary>
Tries to get the value associated with the given key.
Tries to get the value associated with the given key and cast it to <typeparamref name="TItem" />.
</summary>
<returns>
<c>true</c> if the key was found; <c>false</c> otherwise.</returns>
<remarks>To be added.</remarks>
<c>true</c> if the key was found and the stored value can be cast to <typeparamref name="TItem" />; <c>false</c> otherwise.</returns>
<remarks>
This method returns <c>false</c> both when the key is not present in the cache and when the key is present but the stored value can't be cast to <typeparamref name="TItem" />. If you need to distinguish between these two cases (for example, in instrumented caches tracking hit/miss metrics), use the non-generic <see cref="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.TryGetValue(System.Object,System.Object@)" /> method instead, which returns <c>true</c> if the key is present regardless of type.
</remarks>
</Docs>
</Member>
</Members>
Expand Down