Skip to content

Docs (persistQueryClient.md) describe incorrect PersistedClient interface definition #9313

Closed
@Wiktor102

Description

@Wiktor102

Describe the bug

The docs describe the PersistedClient interface as

export interface PersistedClient {
  timestamp: number
  buster: string
  cacheState: any
}

That interface is incorrect as of the newest versions.

Your minimal, reproducible example

https://tanstack.com/query/latest/docs/framework/react/plugins/persistQueryClient#persisters

Steps to reproduce

https://tanstack.com/query/latest/docs/framework/react/plugins/persistQueryClient#persisters

Expected behavior

The interface defined here is different:

export interface PersistedClient {
timestamp: number
buster: string
clientState: DehydratedState
}

Notice the absence of cacheState. Instead, there is clientState. The docs should be updated to reflect the real interface used.

How often does this bug happen?

Every time

Screenshots or Videos

No response

Platform

Chrome

Tanstack Query adapter

None

TanStack Query version

v5.80.6

TypeScript version

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions