Skip to content

fix: enable global mutate to revalidate useSWRInfinite data with includeSpecialKeys option #4167

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+501 −1
Open

fix: enable global mutate to revalidate useSWRInfinite data with includeSpecialKeys option #4167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1bebb4
fix: add includeSpecialKeys option to support global mutate for useSW…
joseph0926 Aug 25, 2025
5310da8
fix: remove unnecessary any type assertions
joseph0926 Aug 28, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/_internal/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@ export type MutatorOptions<Data = any, MutationData = Data> = {
| ((currentData: Data | undefined, displayedData: Data | undefined) => Data)
rollbackOnError?: boolean | ((error: unknown) => boolean)
throwOnError?: boolean
includeSpecialKeys?: boolean
}

export type MutatorConfig = {
Expand Down
16 changes: 15 additions & 1 deletion src/_internal/utils/mutate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import type {
Arguments,
Key
} from '../types'
import type { SWRInfiniteCacheValue } from '../../infinite/types'

type KeyFilter = (key?: Arguments) => boolean
type MutateState<Data> = State<Data, any> & {
Expand Down Expand Up @@ -60,6 +61,8 @@ export async function internalMutate<Data>(
const rollbackOnErrorOption = options.rollbackOnError
let optimisticData = options.optimisticData

const includeSpecialKeys = options.includeSpecialKeys === true

const rollbackOnError = (error: unknown): boolean => {
return typeof rollbackOnErrorOption === 'function'
? rollbackOnErrorOption(error)
Expand All @@ -74,12 +77,23 @@ export async function internalMutate<Data>(
const matchedKeys: Key[] = []
const it = cache.keys()
for (const key of it) {
const shouldSkipSpecialKeys =
!includeSpecialKeys && /^\$(inf|sub)\$/.test(key)
if (
// Skip the special useSWRInfinite and useSWRSubscription keys.
!/^\$(inf|sub)\$/.test(key) &&
!shouldSkipSpecialKeys &&
keyFilter((cache.get(key) as { _k: Arguments })._k)
) {
matchedKeys.push(key)

if (includeSpecialKeys && /^\$inf\$/.test(key)) {
const [get, set] = createCacheHelper<any, SWRInfiniteCacheValue>(
cache,
key
)
const current = get()
set({ ...current, _i: true })
}
}
}
return Promise.all(matchedKeys.map(mutateByKey))
Expand Down
Loading