Merge pull request #2 from tannerlinsley/master

update
TkDodo · Apr 2, 2021 · 7e7d2d3 · 7e7d2d3
2 parents e42cbc3 + 7b14ef5
commit 7e7d2d3
Show file tree

Hide file tree

Showing 16 changed files with 362 additions and 3 deletions.
diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json
@@ -0,0 +1,5 @@
+{
+  "packages": ["./"],
+  "sandboxes": ["/examples/basic", "/examples/basic-typescript"],
+  "node": "14"
+}
diff --git a/examples/basic-typescript/.babelrc b/examples/basic-typescript/.babelrc
@@ -0,0 +1,4 @@
+{
+  "presets": ["react-app"],
+  "plugins": ["styled-components"]
+}
diff --git a/examples/basic-typescript/.eslintrc b/examples/basic-typescript/.eslintrc
@@ -0,0 +1,7 @@
+{
+  "extends": ["react-app", "prettier"],
+  "rules": {
+    // "eqeqeq": 0,
+    // "jsx-a11y/anchor-is-valid": 0
+  }
+}
diff --git a/examples/basic-typescript/.gitignore b/examples/basic-typescript/.gitignore
@@ -0,0 +1,26 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+yarn.lock
+package-lock.json
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/examples/basic-typescript/.prettierrc b/examples/basic-typescript/.prettierrc
@@ -0,0 +1 @@
+{}
diff --git a/examples/basic-typescript/.rescriptsrc.js b/examples/basic-typescript/.rescriptsrc.js
@@ -0,0 +1,37 @@
+const path = require("path");
+const resolveFrom = require("resolve-from");
+
+const fixLinkedDependencies = (config) => {
+  config.resolve = {
+    ...config.resolve,
+    alias: {
+      ...config.resolve.alias,
+      react$: resolveFrom(path.resolve("node_modules"), "react"),
+      "react-dom$": resolveFrom(path.resolve("node_modules"), "react-dom"),
+    },
+  };
+  return config;
+};
+
+const includeSrcDirectory = (config) => {
+  config.resolve = {
+    ...config.resolve,
+    modules: [path.resolve("src"), ...config.resolve.modules],
+  };
+  return config;
+};
+
+const allowOutsideSrc = (config) => {
+  config.resolve.plugins = config.resolve.plugins.filter(
+    (p) => p.constructor.name !== "ModuleScopePlugin"
+  );
+  return config;
+};
+
+module.exports = [
+  ["use-babel-config", ".babelrc"],
+  ["use-eslint-config", ".eslintrc"],
+  fixLinkedDependencies,
+  allowOutsideSrc,
+  // includeSrcDirectory,
+];
diff --git a/examples/basic-typescript/README.md b/examples/basic-typescript/README.md
@@ -0,0 +1,6 @@
+# Example
+
+To run this example:
+
+- `npm install` or `yarn`
+- `npm run start` or `yarn start`
diff --git a/examples/basic-typescript/package.json b/examples/basic-typescript/package.json
@@ -0,0 +1,40 @@
+{
+  "private": true,
+  "scripts": {
+    "start": "rescripts start",
+    "build": "rescripts build",
+    "test": "rescripts test",
+    "eject": "rescripts eject"
+  },
+  "dependencies": {
+    "axios": "^0.21.1",
+    "broadcast-channel": "^3.4.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-query": "^3.13.3",
+    "react-scripts": "3.0.1",
+    "stop-runaway-react-effects": "^1.2.0",
+    "styled-components": "^4.3.2",
+    "typescript": "^4.2.3"
+  },
+  "devDependencies": {
+    "@rescripts/cli": "^0.0.11",
+    "@rescripts/rescript-use-babel-config": "^0.0.8",
+    "@rescripts/rescript-use-eslint-config": "^0.0.9",
+    "@types/react": "^17.0.3",
+    "@types/react-dom": "^17.0.3",
+    "babel-eslint": "10.0.1"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}
diff --git a/examples/basic-typescript/public/favicon.ico b/examples/basic-typescript/public/favicon.ico
@@ -0,0 +1 @@
+https://rawcdn.githack.com/tannerlinsley/react-query/master/examples/basic/public/favicon.ico
diff --git a/examples/basic-typescript/public/index.html b/examples/basic-typescript/public/index.html
@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/examples/basic-typescript/public/manifest.json b/examples/basic-typescript/public/manifest.json
@@ -0,0 +1,15 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/examples/basic-typescript/src/index.tsx b/examples/basic-typescript/src/index.tsx
@@ -0,0 +1,153 @@
+/* eslint-disable jsx-a11y/anchor-is-valid */
+import * as React from "react";
+import ReactDOM from "react-dom";
+import axios from "axios";
+import {
+  useQuery,
+  useQueryClient,
+  QueryClient,
+  QueryClientProvider,
+} from "react-query";
+import { ReactQueryDevtools } from "react-query/devtools";
+
+const queryClient = new QueryClient();
+
+type Post = {
+  id: number;
+  title: string;
+  body: string;
+};
+
+function usePosts() {
+  return useQuery(
+    "posts",
+    async (): Promise<Array<Post>> => {
+      const { data } = await axios.get(
+        "https://jsonplaceholder.typicode.com/posts"
+      );
+      return data;
+    }
+  );
+}
+
+function Posts({
+  setPostId,
+}: {
+  setPostId: React.Dispatch<React.SetStateAction<number>>;
+}) {
+  const queryClient = useQueryClient();
+  const { status, data, error, isFetching } = usePosts();
+
+  return (
+    <div>
+      <h1>Posts</h1>
+      <div>
+        {status === "loading" ? (
+          "Loading..."
+        ) : error instanceof Error ? (
+          <span>Error: {error.message}</span>
+        ) : (
+          <>
+            <div>
+              {data?.map((post) => (
+                <p key={post.id}>
+                  <a
+                    onClick={() => setPostId(post.id)}
+                    href="#"
+                    style={
+                      // We can access the query data here to show bold links for
+                      // ones that are cached
+                      queryClient.getQueryData(["post", post.id])
+                        ? {
+                            fontWeight: "bold",
+                            color: "green",
+                          }
+                        : {}
+                    }
+                  >
+                    {post.title}
+                  </a>
+                </p>
+              ))}
+            </div>
+            <div>{isFetching ? "Background Updating..." : " "}</div>
+          </>
+        )}
+      </div>
+    </div>
+  );
+}
+
+const getPostById = async (id: number): Promise<Post> => {
+  const { data } = await axios.get(
+    `https://jsonplaceholder.typicode.com/posts/${id}`
+  );
+  return data;
+};
+
+function usePost(postId: number) {
+  return useQuery(["post", postId], () => getPostById(postId), {
+    enabled: !!postId,
+  });
+}
+
+function Post({
+  postId,
+  setPostId,
+}: {
+  postId: number;
+  setPostId: React.Dispatch<React.SetStateAction<number>>;
+}) {
+  const { status, data, error, isFetching } = usePost(postId);
+
+  return (
+    <div>
+      <div>
+        <a onClick={() => setPostId(-1)} href="#">
+          Back
+        </a>
+      </div>
+      {!postId || status === "loading" ? (
+        "Loading..."
+      ) : error instanceof Error ? (
+        <span>Error: {error.message}</span>
+      ) : (
+        <>
+          <h1>{data?.title}</h1>
+          <div>
+            <p>{data?.body}</p>
+          </div>
+          <div>{isFetching ? "Background Updating..." : " "}</div>
+        </>
+      )}
+    </div>
+  );
+}
+
+function App() {
+  const [postId, setPostId] = React.useState(-1);
+
+  return (
+    <QueryClientProvider client={queryClient}>
+      <p>
+        As you visit the posts below, you will notice them in a loading state
+        the first time you load them. However, after you return to this list and
+        click on any posts you have already visited again, you will see them
+        load instantly and background refresh right before your eyes!{" "}
+        <strong>
+          (You may need to throttle your network speed to simulate longer
+          loading sequences)
+        </strong>
+      </p>
+      {postId > -1 ? (
+        <Post postId={postId} setPostId={setPostId} />
+      ) : (
+        <Posts setPostId={setPostId} />
+      )}
+      <ReactQueryDevtools initialIsOpen />
+    </QueryClientProvider>
+  );
+}
+
+const rootElement = document.getElementById("root");
+ReactDOM.render(<App />, rootElement);
diff --git a/examples/basic-typescript/tsconfig.json b/examples/basic-typescript/tsconfig.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react"
+  },
+  "include": [
+    "src"
+  ]
+}
diff --git a/examples/optimistic-updates-typescript/package.json b/examples/optimistic-updates-typescript/package.json
@@ -11,7 +11,7 @@
     "next": "9.2.2",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
-    "react-query": "3.5.1",
+    "react-query": "^3.5.1",
     "typescript": "^4.1.2"
   },
   "scripts": {

diff --git a/src/core/infiniteQueryObserver.ts b/src/core/infiniteQueryObserver.ts
@@ -71,7 +71,7 @@ export class InfiniteQueryObserver<
   ): void {
     super.setOptions({
       ...options,
-      behavior: infiniteQueryBehavior<TQueryFnData, TError, TData>(),
+      behavior: infiniteQueryBehavior(),
     })
   }
 

diff --git a/src/core/types.ts b/src/core/types.ts
@@ -90,7 +90,7 @@ export interface QueryObserverOptions<
   TData = TQueryFnData,
   TQueryData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey
-> extends QueryOptions<TQueryFnData, TError, TData, TQueryKey> {
+> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
   /**
    * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
    * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		https://rawcdn.githack.com/tannerlinsley/react-query/master/examples/basic/public/favicon.ico