Merge branch 'master' of https://github.com/tannerlinsley/react-query

Author: tannerlinsley

README.md

@@ -14,7 +14,7 @@ Hooks for fetching, caching and updating asynchronous data in React
     <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
   </a><a href="https://github.com/tannerlinsley/react-query/discussions">
   <img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
-</a><a href="https://github.com/tannerlinsley/react-query" target="\_parent">
+</a><a href="https://bestofjs.org/projects/react-query"><img alt="Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=tannerlinsley%2Freact-query%26since=daily" /></a><a href="https://github.com/tannerlinsley/react-query" target="\_parent">
   <img alt="" src="https://img.shields.io/github/stars/tannerlinsley/react-query.svg?style=social&label=Star" />
 </a><a href="https://twitter.com/tannerlinsley" target="\_parent">
   <img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />

docs/src/components/LayoutDocs.js

@@ -60,7 +60,14 @@ export const LayoutDocs = props => {
       )}
       <div>
         {isMobile ? (
-          <Nav />
+          <>
+            <Nav />
+            <Sticky shadow>
+              <SidebarMobile>
+                <SidebarRoutes isMobile={true} routes={routes} />
+              </SidebarMobile>
+            </Sticky>
+          </>
         ) : (
           <Sticky>
             <Nav />
@@ -72,17 +79,14 @@ export const LayoutDocs = props => {
         />
         <div className="block">
           <>
-            <Sticky shadow>
-              <SidebarMobile>
-                <SidebarRoutes isMobile={true} routes={routes} />
-              </SidebarMobile>
-            </Sticky>
 
             <div className="container mx-auto pb-12 pt-6 content">
               <div className="flex relative">
-                <Sidebar fixed>
-                  <SidebarRoutes routes={routes} />
-                </Sidebar>
+                {!isMobile && (
+                  <Sidebar fixed>
+                    <SidebarRoutes routes={routes} />
+                  </Sidebar>
+                )}
 
                 <div className={s['markdown'] + ' w-full docs'}>
                   <h1>{props.meta.title}</h1>
@@ -172,7 +176,7 @@ function SidebarRoutes({ isMobile, routes: currentRoutes, level = 1 }) {
 
     const pagePath = removeFromLast(path, '.')
     const pathname = addTagToSlug(pagePath, tag)
-    const selected = slug.startsWith(pagePath)
+    const selected = slug === pagePath
     const route = {
       href: pagePath,
       path,

docs/src/pages/docs/api.md

@@ -296,8 +296,6 @@ const promise = mutate(variables, {
   - The last successfully resolved data for the query.
 - `error: null | Error`
   - The error object for the query, if an error was encountered.
-- `promise: Promise`
-  - The promise that is returned by the `mutationFn`.
 
 ## `queryCache`
 

docs/src/pages/docs/comparison.md

@@ -9,7 +9,7 @@ Feature/Capability Key:
 
 - ✅ 1st-class, built-in, and ready to use with no added configuration or code
 - 🟡 Supported, but as an unoffical 3rd party or community library/contribution
-- 🔶 Supported and documented, but requires extra user-code implement
+- 🔶 Supported and documented, but requires extra user-code to implement
 - 🛑 Not officially supported or documented.
 
 |                                              | React Query                            | SWR [(Website)](https://github.com/vercel/swr) | Apollo Client [(Website)](https://github.com/apollographql/apollo-client) |

types/index.d.ts

@@ -378,7 +378,7 @@ export type PaginatedQueryResult<TResult, TError = Error> =
 
 export interface InfiniteQueryResult<TResult, TMoreVariable, TError = Error>
   extends QueryResultBase<TResult[], TError> {
-  data: TResult[]
+  data: TResult[] | undefined
   isFetchingMore: false | 'previous' | 'next'
   canFetchMore: boolean | undefined
   fetchMore: (
@@ -462,7 +462,6 @@ export interface MutationResultBase<TResult, TError = Error> {
   isLoading: boolean
   isSuccess: boolean
   isError: boolean
-  promise: Promise<TResult>
   reset: () => void
 }
 
@@ -627,7 +626,7 @@ export interface QueryCache {
   ): void
   isFetching: number
   subscribe(callback: (queryCache: QueryCache) => void): () => void
-  clear(): void
+  clear(options?: { notify?: boolean }): void
   resetErrorBoundaries: () => void
 }
 

types/test.ts

@@ -339,7 +339,7 @@ function simpleInfiniteQuery(condition: boolean) {
   //     getFetchMore: (last, all) => 'string',
   // });
 
-  infiniteQuery.data // $ExpectType number[][]
+  infiniteQuery.data // $ExpectType number[][] | undefined
   infiniteQuery.fetchMore() // $ExpectType Promise<number[][]> | undefined
   infiniteQuery.fetchMore('next') // $ExpectType Promise<number[][]> | undefined
   infiniteQuery.fetchMore('next', { previous: true }) // $ExpectType Promise<number[][]> | undefined
@@ -352,14 +352,14 @@ function infiniteQueryWithObjectSyntax() {
     config: {
       getFetchMore: (last: { next: number }) => last.next, // annotation on this type is required to infer the type
     },
-  }).data // $ExpectType { next: number; }[]
+  }).data // $ExpectType { next: number; }[] | undefined
   useInfiniteQuery({
     queryKey: ['key', 1],
     queryFn: async (key, id, next = 0) => ({ next: next + 1 }),
     config: {
       getFetchMore: (last: { next: number }) => last.next, // annotation on this type is required to infer the type
     },
-  }).data // $ExpectType { next: number; }[]
+  }).data // $ExpectType { next: number; }[] | undefined
   useInfiniteQuery({
     queryKey: 'key',
     queryFn: async (
@@ -369,7 +369,7 @@ function infiniteQueryWithObjectSyntax() {
     config: {
       getFetchMore: (last: { next: number }) => last.next, // annotation on this type is required to infer the type
     },
-  }).data // $ExpectType { next: number; }[]
+  }).data // $ExpectType { next: number; }[] | undefined
   useInfiniteQuery({
     queryKey: 'key',
     queryFn: async (
@@ -379,15 +379,15 @@ function infiniteQueryWithObjectSyntax() {
     config: {
       getFetchMore: (last: { next: number }) => last.next, // annotation on this type is required to infer the type
     },
-  }).data // $ExpectType { next: number; }[]
+  }).data // $ExpectType { next: number; }[] | undefined
 
   useInfiniteQuery<{ next: number }, string, undefined>({
     queryKey: 'key',
-  }).data // $ExpectType { next: number; }[]
+  }).data // $ExpectType { next: number; }[] | undefined
 
   useInfiniteQuery<{ next: number }, [string], undefined>({
     queryKey: ['key'],
-  }).data // $ExpectType { next: number; }[]
+  }).data // $ExpectType { next: number; }[] | undefined
 }
 
 function log(...args: any[]) {}
@@ -431,6 +431,7 @@ function simpleMutation() {
   mutationState.isSuccess // $ExpectType boolean
   mutationState.reset // $ExpectType () => void
   mutationState.status // $ExpectType "idle" | "loading" | "error" | "success"
+  mutationState.promise // $ExpectError
 }
 
 function mutationWithVariables() {