Merge branch 'master' into feature/2149

# Conflicts:
#	src/core/types.ts

Author: TkDodo

.github/workflows/test-and-publish.yml

@@ -16,10 +16,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [10, 12, 14]
+        node: [10, 12, 14, 16]
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
       - name: Install dependencies
@@ -34,7 +34,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: 14
           registry-url: https://registry.npmjs.org/

docs/src/pages/guides/filters.md

@@ -13,13 +13,13 @@ A query filter is an object with certain conditions to match a query with:
 // Cancel all queries
 await queryClient.cancelQueries()
 
-// Remove all inactive queries
+// Remove all inactive queries that begin with `posts` in the key
 queryClient.removeQueries('posts', { inactive: true })
 
 // Refetch all active queries
 await queryClient.refetchQueries({ active: true })
 
-// Refetch all active queries that begin with `post` in the key
+// Refetch all active queries that begin with `posts` in the key
 await queryClient.refetchQueries('posts', { active: true })
 ```
 

docs/src/pages/guides/mutations.md

@@ -44,7 +44,7 @@ A mutation can only be in one of the following states at any given moment:
 - `isError` or `status === 'error'` - The mutation encountered an error
 - `isSuccess` or `status === 'success'` - The mutation was successful and mutation data is available
 
-Beyond those primary state, more information is available depending on the state the mutation:
+Beyond those primary states, more information is available depending on the state of the mutation:
 
 - `error` - If the mutation is in an `isError` state, the error is available via the `error` property.
 - `data` - If the mutation is in a `success` state, the data is available via the `data` property.

docs/src/pages/guides/placeholder-query-data.md

@@ -43,7 +43,7 @@ In some circumstances, you may be able to provide the placeholder data for a que
 
 ```js
 function Todo({ blogPostId }) {
-  const result = useQuery(['blogPost', blogPostId], () => fetch('/blogPosts'), {
+  const result = useQuery(['blogPost', blogPostId], () => fetch(`/blogPosts/${blogPostId}`), {
     placeholderData: () => {
       // Use the smaller/preview version of the blogPost from the 'blogPosts' query as the placeholder data for this blogPost query
       return queryClient

docs/src/pages/guides/updates-from-mutation-responses.md

@@ -9,7 +9,9 @@ When dealing with mutations that **update** objects on the server, it's common f
 const queryClient = useQueryClient()
 
 const mutation = useMutation(editTodo, {
-  onSuccess: data => queryClient.setQueryData(['todo', { id: 5 }], data),
+  onSuccess: data => {
+    queryClient.setQueryData(['todo', { id: 5 }], data)
+  }
 })
 
 mutation.mutate({

docs/src/pages/plugins/persistQueryClient.md

@@ -94,6 +94,10 @@ interface PersistQueryClientOptions {
   /** A unique string that can be used to forcefully
    * invalidate existing caches if they do not share the same buster string */
   buster?: string
+  /** The options passed to the hydrate function */
+  hydrateOptions?: HydrateOptions
+  /** The options passed to the dehydrate function */
+  dehydrateOptions?: DehydrateOptions
 }
 ```
 

docs/src/pages/reference/useMutation.md

@@ -46,15 +46,15 @@ mutate(variables, {
   - This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
   - Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
   - The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.
-- `onSuccess: (data: TData, variables: TVariables, context?: TContext) => Promise<void> | void`
+- `onSuccess: (data: TData, variables: TVariables, context?: TContext) => Promise<unknown> | void`
   - Optional
   - This function will fire when the mutation is successful and will be passed the mutation's result.
   - If a promise is returned, it will be awaited and resolved before proceeding
-- `onError: (err: TError, variables: TVariables, context?: TContext) => Promise<void> | void`
+- `onError: (err: TError, variables: TVariables, context?: TContext) => Promise<unknown> | void`
   - Optional
   - This function will fire if the mutation encounters an error and will be passed the error.
   - If a promise is returned, it will be awaited and resolved before proceeding
-- `onSettled: (data: TData, error: TError, variables: TVariables, context?: TContext) => Promise<void> | void`
+- `onSettled: (data: TData, error: TError, variables: TVariables, context?: TContext) => Promise<unknown> | void`
   - Optional
   - This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
   - If a promise is returned, it will be awaited and resolved before proceeding

package.json

@@ -22,9 +22,10 @@
   ],
   "scripts": {
     "test": "is-ci \"test:ci\" \"test:dev\"",
-    "test:dev": "npm run test:types && npm run test:eslint && jest --watch",
-    "test:ci": "npm run test:types && npm run test:eslint && jest",
+    "test:dev": "npm run test:types && npm run test:format && npm run test:eslint && jest --watch",
+    "test:ci": "npm run test:types && npm run test:format && npm run test:eslint && jest",
     "test:coverage": "yarn test:ci; open coverage/lcov-report/index.html",
+    "test:format": "yarn prettier --check",
     "test:types": "tsc",
     "test:eslint": "eslint --ext .ts,.tsx ./src",
     "build": "yarn build:commonjs && yarn build:es && yarn build:umd && yarn build:types",
@@ -38,8 +39,9 @@
     "watch:umd": "rimraf ./dist && cross-env NODE_ENV=production rollup -w -c && rollup-plugin-visualizer stats-react.json",
     "watch:types": "rimraf ./types && tsc --watch --project ./tsconfig.types.json && replace 'import type' 'import' ./types -r --silent && replace 'export type' 'export' ./types -r --silent",
     "now-build": "yarn && cd www && yarn && yarn build",
+    "prettier": "prettier \"{.,src,src/**,example/src,example/src/**,types}/*.{md,js,jsx,ts,tsx,json}\"",
     "start": "yarn watch",
-    "format": "prettier {.,src,src/**,example/src,example/src/**,types}/*.{md,js,jsx,tsx,json} --write",
+    "format": "yarn prettier --write",
     "stats": "open ./stats.html"
   },
   "files": [
@@ -108,7 +110,7 @@
     "eslint-plugin-standard": "^4.0.1",
     "is-ci-cli": "^2.1.1",
     "jest": "^26.0.1",
-    "prettier": "^2.0.5",
+    "prettier": "2.2.1",
     "react": "^16.13.0",
     "react-dom": "^16.13.1",
     "react-error-boundary": "^2.2.2",

src/core/focusManager.ts

@@ -12,12 +12,12 @@ class FocusManager extends Subscribable {
   }
 
   setEventListener(
-    setup: (onFocus: () => void) => (focused?: boolean) => void
+    setup: (setFocused: (focused?: boolean) => void) => () => void
   ): void {
     if (this.removeEventListener) {
       this.removeEventListener()
     }
-    this.removeEventListener = setup((focused?: boolean) => {
+    this.removeEventListener = setup(focused => {
       if (typeof focused === 'boolean') {
         this.setFocused(focused)
       } else {
@@ -58,14 +58,15 @@ class FocusManager extends Subscribable {
   private setDefaultEventListener() {
     if (!isServer && window?.addEventListener) {
       this.setEventListener(onFocus => {
+        const listener = () => onFocus()
         // Listen to visibillitychange and focus
-        window.addEventListener('visibilitychange', onFocus, false)
-        window.addEventListener('focus', onFocus, false)
+        window.addEventListener('visibilitychange', listener, false)
+        window.addEventListener('focus', listener, false)
 
         return () => {
           // Be sure to unsubscribe if a new handler is set
-          window.removeEventListener('visibilitychange', onFocus)
-          window.removeEventListener('focus', onFocus)
+          window.removeEventListener('visibilitychange', listener)
+          window.removeEventListener('focus', listener)
         }
       })
     }

src/core/mutationCache.ts

@@ -76,12 +76,7 @@ export class MutationCache extends Subscribable<MutationCacheListener> {
     return this.mutations
   }
 
-  find<
-    TData = unknown,
-    TError = unknown,
-    TVariables = any,
-    TContext = unknown
-  >(
+  find<TData = unknown, TError = unknown, TVariables = any, TContext = unknown>(
     filters: MutationFilters
   ): Mutation<TData, TError, TVariables, TContext> | undefined {
     if (typeof filters.exact === 'undefined') {