Merge branch 'main' into docs/query-core-tsdocs

TanStack · May 10, 2024 · e2bc5cb · e2bc5cb
2 parents f92d40d + 2a3111b
commit e2bc5cb
Show file tree

Hide file tree

Showing 73 changed files with 232 additions and 220 deletions.
diff --git a/docs/framework/react/guides/query-functions.md b/docs/framework/react/guides/query-functions.md
@@ -111,4 +111,6 @@ Additionally, [Infinite Queries](../infinite-queries) get the following options
 - `pageParam: TPageParam`
   - the page parameter used to fetch the current page
 - `direction: 'forward' | 'backward'`
+  - **deprecated**
   - the direction of the current page fetch
+  - To get access to the direction of the current page fetch, please add a direction to `pageParam` from `getNextPageParam` and `getPreviousPageParam`.
diff --git a/docs/framework/react/guides/ssr.md b/docs/framework/react/guides/ssr.md
@@ -476,7 +476,7 @@ dehydrate(queryClient, {
 
 When doing `return { props: { dehydratedState: dehydrate(queryClient) } }` in Next.js, or `return json({ dehydratedState: dehydrate(queryClient) })` in Remix, what happens is that the `dehydratedState` representation of the `queryClient` is serialized by the framework so it can be embedded into the markup and transported to the client.
 
-By default, these frameworks only supports returning things that are safely serializable/parsable, and therefor does not support `undefined`, `Error`, `Date`, `Map`, `Set`, `BigInt`, `Infinity`, `NaN`, `-0`, regular expressions etc. This also means that you can not return any of these things from your queries. If returning these values is something you want, check out [superjson](https://github.com/blitz-js/superjson) or similar packages.
+By default, these frameworks only supports returning things that are safely serializable/parsable, and therefore does not support `undefined`, `Error`, `Date`, `Map`, `Set`, `BigInt`, `Infinity`, `NaN`, `-0`, regular expressions etc. This also means that you can not return any of these things from your queries. If returning these values is something you want, check out [superjson](https://github.com/blitz-js/superjson) or similar packages.
 
 If you are using a custom SSR setup, you need to take care of this step yourself. Your first instinct might be to use `JSON.stringify(dehydratedState)`, but because this doesn't escape things like `<script>alert('Oh no..')</script>` by default, this can easily lead to **XSS-vulnerabilities** in your application. [superjson](https://github.com/blitz-js/superjson) also **does not** escape values and is unsafe to use by itself in a custom SSR setup (unless you add an extra step for escaping the output). Instead we recommend using a library like [Serialize JavaScript](https://github.com/yahoo/serialize-javascript) or [devalue](https://github.com/Rich-Harris/devalue) which are both safe against XSS injections out of the box.
 

diff --git a/docs/framework/react/guides/window-focus-refetching.md b/docs/framework/react/guides/window-focus-refetching.md
@@ -50,10 +50,13 @@ In rare circumstances, you may want to manage your own window focus events that
 focusManager.setEventListener((handleFocus) => {
   // Listen to visibilitychange
   if (typeof window !== 'undefined' && window.addEventListener) {
-    window.addEventListener('visibilitychange', () => handleFocus(), false)
+    const visibilitychangeHandler = () => {
+      handleFocus(document.visibilityState === 'visible')
+    }
+    window.addEventListener('visibilitychange', visibilitychangeHandler, false)
     return () => {
       // Be sure to unsubscribe if a new handler is set
-      window.removeEventListener('visibilitychange', () => handleFocus())
+      window.removeEventListener('visibilitychange', visibilitychangeHandler)
     }
   }
 })

diff --git a/examples/angular/basic/package.json b/examples/angular/basic/package.json
@@ -17,7 +17,7 @@
     "@angular/platform-browser": "^17.3.3",
     "@angular/platform-browser-dynamic": "^17.3.3",
     "@angular/router": "^17.3.3",
-    "@tanstack/angular-query-experimental": "^5.35.3",
+    "@tanstack/angular-query-experimental": "^5.35.4",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2",
     "zone.js": "^0.14.4"
@@ -26,7 +26,7 @@
     "@angular-devkit/build-angular": "^17.3.3",
     "@angular/cli": "^17.3.3",
     "@angular/compiler-cli": "^17.3.3",
-    "@tanstack/angular-query-devtools-experimental": "^5.35.3",
+    "@tanstack/angular-query-devtools-experimental": "^5.35.4",
     "typescript": "5.2.2"
   }
 }
diff --git a/examples/angular/infinite-query-with-max-pages/package.json b/examples/angular/infinite-query-with-max-pages/package.json
@@ -17,7 +17,7 @@
     "@angular/platform-browser": "^17.3.3",
     "@angular/platform-browser-dynamic": "^17.3.3",
     "@angular/router": "^17.3.3",
-    "@tanstack/angular-query-experimental": "^5.35.3",
+    "@tanstack/angular-query-experimental": "^5.35.4",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2",
     "zone.js": "^0.14.4"
@@ -26,7 +26,7 @@
     "@angular-devkit/build-angular": "^17.3.3",
     "@angular/cli": "^17.3.3",
     "@angular/compiler-cli": "^17.3.3",
-    "@tanstack/angular-query-devtools-experimental": "^5.35.3",
+    "@tanstack/angular-query-devtools-experimental": "^5.35.4",
     "typescript": "5.2.2"
   }
 }
diff --git a/examples/angular/router/package.json b/examples/angular/router/package.json
@@ -17,7 +17,7 @@
     "@angular/platform-browser": "^17.3.3",
     "@angular/platform-browser-dynamic": "^17.3.3",
     "@angular/router": "^17.3.3",
-    "@tanstack/angular-query-experimental": "^5.35.3",
+    "@tanstack/angular-query-experimental": "^5.35.4",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2",
     "zone.js": "^0.14.4"
@@ -26,7 +26,7 @@
     "@angular-devkit/build-angular": "^17.3.3",
     "@angular/cli": "^17.3.3",
     "@angular/compiler-cli": "^17.3.3",
-    "@tanstack/angular-query-devtools-experimental": "^5.35.3",
+    "@tanstack/angular-query-devtools-experimental": "^5.35.4",
     "typescript": "5.2.2"
   }
 }
diff --git a/examples/angular/simple/package.json b/examples/angular/simple/package.json
@@ -17,7 +17,7 @@
     "@angular/platform-browser": "^17.3.3",
     "@angular/platform-browser-dynamic": "^17.3.3",
     "@angular/router": "^17.3.3",
-    "@tanstack/angular-query-experimental": "^5.35.3",
+    "@tanstack/angular-query-experimental": "^5.35.4",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2",
     "zone.js": "^0.14.4"
@@ -26,7 +26,7 @@
     "@angular-devkit/build-angular": "^17.3.3",
     "@angular/cli": "^17.3.3",
     "@angular/compiler-cli": "^17.3.3",
-    "@tanstack/angular-query-devtools-experimental": "^5.35.3",
+    "@tanstack/angular-query-devtools-experimental": "^5.35.4",
     "typescript": "5.2.2"
   }
 }
diff --git a/examples/react/algolia/package.json b/examples/react/algolia/package.json
@@ -11,8 +11,8 @@
   "dependencies": {
     "@algolia/client-search": "4.22.1",
     "@algolia/transporter": "4.22.1",
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "algoliasearch": "4.22.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/auto-refetching/package.json b/examples/react/auto-refetching/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/basic-graphql-request/package.json b/examples/react/basic-graphql-request/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "graphql": "^16.8.1",
     "graphql-request": "^6.1.0",
     "react": "^18.2.0",

diff --git a/examples/react/basic-typescript/package.json b/examples/react/basic-typescript/package.json
@@ -9,10 +9,10 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/query-sync-storage-persister": "^5.35.1",
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
-    "@tanstack/react-query-persist-client": "^5.35.1",
+    "@tanstack/query-sync-storage-persister": "^5.35.4",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
+    "@tanstack/react-query-persist-client": "^5.35.4",
     "axios": "^1.6.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/default-query-function/package.json b/examples/react/default-query-function/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/infinite-query-with-max-pages/package.json b/examples/react/infinite-query-with-max-pages/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/load-more-infinite-scroll/package.json b/examples/react/load-more-infinite-scroll/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/nextjs-suspense-streaming/package.json b/examples/react/nextjs-suspense-streaming/package.json
@@ -8,9 +8,9 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
-    "@tanstack/react-query-next-experimental": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
+    "@tanstack/react-query-next-experimental": "^5.35.4",
     "next": "^14.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

diff --git a/examples/react/nextjs/package.json b/examples/react/nextjs/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "ky": "^1.2.0",
     "next": "^14.0.0",
     "react": "^18.2.0",

diff --git a/examples/react/offline/package.json b/examples/react/offline/package.json
@@ -8,11 +8,11 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/query-sync-storage-persister": "^5.35.1",
+    "@tanstack/query-sync-storage-persister": "^5.35.4",
     "@tanstack/react-location": "^3.7.4",
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
-    "@tanstack/react-query-persist-client": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
+    "@tanstack/react-query-persist-client": "^5.35.4",
     "ky": "^1.2.0",
     "msw": "^2.1.7",
     "react": "^18.2.0",

diff --git a/examples/react/optimistic-updates-cache/package.json b/examples/react/optimistic-updates-cache/package.json
@@ -8,8 +8,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/optimistic-updates-ui/package.json b/examples/react/optimistic-updates-ui/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/pagination/package.json b/examples/react/pagination/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/playground/package.json b/examples/react/playground/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/prefetching/package.json b/examples/react/prefetching/package.json
@@ -7,8 +7,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "isomorphic-unfetch": "4.0.2",
     "next": "^14.0.0",

diff --git a/examples/react/react-native/package.json b/examples/react/react-native/package.json
@@ -14,8 +14,8 @@
     "@react-native-community/netinfo": "^11.1.0",
     "@react-navigation/native": "^6.1.6",
     "@react-navigation/stack": "^6.3.16",
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "expo": "^50.0.6",
     "expo-constants": "^15.4.5",
     "expo-status-bar": "^1.11.1",

diff --git a/examples/react/react-router/package.json b/examples/react/react-router/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "localforage": "^1.10.0",
     "match-sorter": "^6.3.4",
     "react": "^18.2.0",

diff --git a/examples/react/rick-morty/package.json b/examples/react/rick-morty/package.json
@@ -12,8 +12,8 @@
     "@emotion/styled": "^11.11.0",
     "@mui/material": "^5.15.2",
     "@mui/styles": "^5.15.2",
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-router": "^6.22.0",

diff --git a/examples/react/shadow-dom/package.json b/examples/react/shadow-dom/package.json
@@ -10,8 +10,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/simple/package.json b/examples/react/simple/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/star-wars/package.json b/examples/react/star-wars/package.json
@@ -12,8 +12,8 @@
     "@emotion/styled": "^11.11.0",
     "@mui/material": "^5.15.2",
     "@mui/styles": "^5.15.2",
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-router": "^6.22.0",

diff --git a/examples/react/suspense/package.json b/examples/react/suspense/package.json
@@ -3,8 +3,8 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@tanstack/react-query": "^5.35.1",
-    "@tanstack/react-query-devtools": "^5.35.1",
+    "@tanstack/react-query": "^5.35.4",
+    "@tanstack/react-query-devtools": "^5.35.4",
     "axios": "^1.6.7",
     "font-awesome": "^4.7.0",
     "react": "^18.2.0",

diff --git a/examples/solid/astro/package.json b/examples/solid/astro/package.json
@@ -15,8 +15,8 @@
     "@astrojs/tailwind": "^5.1.0",
     "@astrojs/vercel": "^7.5.3",
     "@astrojs/node": "^8.2.5",
-    "@tanstack/solid-query": "^5.35.1",
-    "@tanstack/solid-query-devtools": "^5.35.1",
+    "@tanstack/solid-query": "^5.35.4",
+    "@tanstack/solid-query-devtools": "^5.35.4",
     "astro": "^4.6.1",
     "solid-js": "^1.8.14",
     "tailwindcss": "^3.4.1",

diff --git a/examples/solid/basic-graphql-request/package.json b/examples/solid/basic-graphql-request/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/solid-query": "^5.35.1",
-    "@tanstack/solid-query-devtools": "^5.35.1",
+    "@tanstack/solid-query": "^5.35.4",
+    "@tanstack/solid-query-devtools": "^5.35.4",
     "graphql": "^16.8.1",
     "graphql-request": "^6.1.0",
     "solid-js": "^1.8.14"