refactor(query-persist-client-core/createPersister): rename the 'filters' option to 'persistFilters' internally to avoid shadowing by sukvvon · Pull Request #12290 · TanStack/query

sukvvon · 2026-10-23T01:06:56Z

🎯 Changes

In experimental_createQueryPersister, destructure the filters option as persistFilters and use it in persisterFn.

The filters parameters of restoreQueries and removeQueries were shadowing the filters option (no-shadow). The option name, the public types, and the restoreQueries/removeQueries signatures stay the same.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

Refactor
- Clarified the internal handling of query persistence filters. Query matching behavior is unchanged.

…ers' option to 'persistFilters' internally to avoid shadowing

changeset-bot · 2026-10-23T01:07:01Z

⚠️ No Changeset found

Latest commit: 8ae2de5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

nx-cloud · 2026-10-23T01:07:22Z

View your CI Pipeline Execution ↗ for commit 8ae2de5

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	3m 22s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	18s	View ↗

☁️ Nx Cloud last updated this comment at 2026-10-23 01:11:27 UTC

github-actions · 2026-10-23T01:07:49Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

coderabbitai · 2026-10-23T01:08:22Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Source mode: Auto
Repository: TanStack/query
Branch: refactor/query-persist-client-core-rename-persist-filters
File: .coderabbit.yaml
Commit: 8ae2de5
Layers: Repository YAML
Review profile: CHILL
Plan: Advanced
Run ID: b8176e9e-2853-4e31-b38f-753f19f32374

📥 Commits

Reviewing files that changed from the base of the PR and between 2de1d1e and 8ae2de5.

📒 Files selected for processing: 1

packages/query-persist-client-core/src/createPersister.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

The persister now binds its filters option to persistFilters and uses that alias when checking whether a query matches. The matching behavior remains unchanged.

Changes: Persistence filter matching

Layer / File(s)	Summary
Bind and use persistence filters `packages/query-persist-client-core/src/createPersister.ts`	The persister binds `filters` to `persistFilters` and passes the alias to `matchQuery`. The default matching behavior is unchanged.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Refactor

Suggested reviewers: maxfreedompollard

Merge Risk: ⚪ Minimal · up to 8ae2d

The internal alias change does not alter persistence filter behavior and is ready to merge.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly identifies the internal rename from `filters` to `persistFilters` and explains that it avoids shadowing.
Description check		The description explains the change and motivation, completes all required checklist items, and states the release impact.
Docstring Coverage		Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

pkg-pr-new · 2026-10-23T01:09:15Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@12290

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@12290

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@12290

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@12290

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@12290

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@12290

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@12290

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@12290

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@12290

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@12290

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@12290

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@12290

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@12290

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@12290

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@12290

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@12290

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@12290

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@12290

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@12290

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@12290

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@12290

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@12290

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@12290

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@12290

commit: 8ae2de5

github-actions · 2026-10-23T01:09:41Z

size-limit report 📦

Path	Size
react full	11.76 KB (0%)
react minimal	8.59 KB (0%)

refactor(query-persist-client-core/createPersister): rename the 'filt…

8ae2de5

…ers' option to 'persistFilters' internally to avoid shadowing

sukvvon self-assigned this Oct 23, 2026

sukvvon merged commit 51e627f into main Oct 23, 2026
9 checks passed

sukvvon deleted the refactor/query-persist-client-core-rename-persist-filters branch October 23, 2026 03:21

Navigation Menu

Repository navigation

refactor(query-persist-client-core/createPersister): rename the 'filters' option to 'persistFilters' internally to avoid shadowing - #12290

refactor(query-persist-client-core/createPersister): rename the 'filters' option to 'persistFilters' internally to avoid shadowing#12290
sukvvon merged 1 commit into
mainfrom
refactor/query-persist-client-core-rename-persist-filters

sukvvon commented Oct 23, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 23, 2026

Uh oh!

nx-cloud Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 23, 2026

Uh oh!

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Oct 23, 2026

Uh oh!

github-actions Bot commented Oct 23, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 23, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 23, 2026

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 23, 2026

🚀 Changeset Version Preview

Uh oh!

coderabbitai Bot commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Oct 23, 2026

Uh oh!

github-actions Bot commented Oct 23, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 23, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 23, 2026 •

edited

Loading

coderabbitai Bot commented Oct 23, 2026 •

edited

Loading