Merge remote-tracking branch 'origin/master' into beta

Author: boschni

docs/src/pages/docs/api.md

@@ -34,6 +34,8 @@ const fans = [
   'Kristóf Poduszló (@kripod)',
   'Peter Pistorius (@peterp)',
   'Agustín Villalobos (@agustin-v)',
+  'Panigo (@rangigo)',
+  'Jesse Jafa, (@awareness481)',
 ]
 
 const Home = () => {

docs/src/pages/index.js

@@ -13,6 +13,7 @@ const {
   isFetching,
   isIdle,
   isLoading,
+  isPlaceholderData,
   isPreviousData,
   isStale,
   isSuccess,
@@ -68,7 +69,7 @@ const result = useQuery({
   - Must return a promise that will either resolves data or throws an error.
 - `enabled: boolean`
   - Set this to `false` to disable this query from automatically running.
-  - Actually it can be anything that will pass a boolean condition. See [Dependent Queries](./guides/queries#dependent-queries) for more information.
+  - Can be used for [Dependent Queries](./guides/queries#dependent-queries).
 - `retry: boolean | number | (failureCount: number, error: TError) => boolean`
   - If `false`, failed queries will not retry by default.
   - If `true`, failed queries will retry infinitely.
@@ -128,11 +129,16 @@ const result = useQuery({
   - Set this to `true` to enable suspense mode.
   - When `true`, `useQuery` will suspend when `status === 'loading'`
   - When `true`, `useQuery` will throw runtime errors when `status === 'error'`
-- `initialData: unknown | () => unknown`
+- `initialData: TData | () => TData`
   - Optional
   - If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
   - If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
   - Initial data is considered stale by default unless a `staleTime` has been set.
+  - `initialData` **is persisted** to the cache
+- `placeholderData: TData | () => TData`
+  - Optional
+  - If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
+  - `placeholderData` is **not persisted** to the cache
 - `keepPreviousData: boolean`
   - Optional
   - Defaults to `false`
@@ -170,6 +176,8 @@ const result = useQuery({
   - The error object for the query, if an error was thrown.
 - `isStale: boolean`
   - Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
+- `isPlaceholderData: boolean`
+  - Will be `true` if the data shown is the placeholder data.
 - `isPreviousData: boolean`
   - Will be `true` when `keepPreviousData` is set and data from the previous query is returned.
 - `isFetchedAfterMount: boolean`

docs/src/pages/reference/useQuery.md

@@ -11,3 +11,13 @@ Things to keep in mind:
 - Changes to types in this repository are considered **non-breaking** and are usually released as **patch** semver changes (otherwise every type enhancement would be a major version!).
 - It is **highly recommended that you lock your react-query package version to a specific patch release and upgrade with the expectation that types may be fixed or upgraded between any release**
 - The non-type-related public API of React Query still follows semver very strictly.
+
+## Defining Custom Hooks
+
+When defining a custom hook you need to specify the result and error types, for example:
+
+```js
+function useGroups() {
+  return useQuery<Group[], Error>('groups', fetchGroups)
+}
+```

docs/src/pages/typescript.md

@@ -12,7 +12,7 @@
     "graphql-request": "^3.1.0",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
-    "react-query": "^2.21.2",
+    "react-query": "2.23.1",
     "react-query-devtools": "^2.4.7",
     "react-scripts": "3.0.1",
     "stop-runaway-react-effects": "^1.2.0",
@@ -36,4 +36,4 @@
       "last 1 safari version"
     ]
   }
-}
+}

examples/basic-graphql-request/package.json

@@ -10,7 +10,7 @@
     "axios": "0.19.2",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
-    "react-query": "^2.21.2",
+    "react-query": "2.23.1",
     "react-query-devtools": "^2.4.7",
     "react-scripts": "3.0.1",
     "stop-runaway-react-effects": "^1.2.0",
@@ -34,4 +34,4 @@
       "last 1 safari version"
     ]
   }
-}
+}

examples/basic-graphql-request/public/favicon.ico

@@ -10,7 +10,7 @@
     "axios": "0.19.2",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
-    "react-query": "^2.21.2",
+    "react-query": "2.23.1",
     "react-query-devtools": "^2.4.7",
     "react-scripts": "3.0.1",
     "stop-runaway-react-effects": "^1.2.0",
@@ -35,4 +35,4 @@
       "last 1 safari version"
     ]
   }
-}
+}