{ "componentChunkName": "component---src-templates-blog-post-js", "path": "/understanding-stale-time-in-react-query/", "result": {"data":{"markdownRemark":{"html":"
import React, { useState } from "react"\nimport { useQuery } from "react-query"\nimport { Link } from "react-router-dom"\nimport axios from "axios"\n\nconst Posts = () => {\n  const { isLoading, isError, error, data } = useQuery(["posts"], async () => {\n    const { data } = await axios.get(\n      `https://jsonplaceholder.typicode.com/posts`\n    )\n    return data\n  })\n\n  const posts = isLoading ? (\n    <div className="d-flex justify-content-center">\n      <div className="spinner-border" role="status">\n        <span className="sr-only"></span>\n      </div>\n    </div>\n  ) : isError ? (\n    <p>{error.message}</p>\n  ) : (\n    data?.map(post => (\n      <li key={post.id}>\n        <Link to={`/posts/${post.id}`}>{post.title}</Link>\n      </li>\n    ))\n  )\n\n  return (\n    <div className="col-8 col-md-6 mx-auto">\n      <h1>Blog Posts</h1>\n      {posts}\n    </div>\n  )\n}\n\nexport default Posts
\n

In the code snippet above, we are fetching a list of 100 blog posts from a fake REST API endpoint. React Query will cache the list of posts and will consider it as stale. By default, stale queries are automatically refetched in the background, for example, when window is refocused or network is reconnected.

\n

Consider a scenario where the list of posts are not updated often. So, there is no point refetching the data everytime we refocus on our window.

\n

We can decide the time interval at which our query will get refetched by adding a staleTime property in the configuration object.

\n
import React, { useState } from "react"\nimport { useQuery } from "react-query"\nimport { Link } from "react-router-dom"\nimport axios from "axios"\n\nconst Posts = () => {\n  const { isLoading, isError, error, data } = useQuery(\n    ["posts"],\n    async () => {\n      const { data } = await axios.get(\n        `https://jsonplaceholder.typicode.com/posts`\n      )\n      return data\n    },\n    {\n      staleTime: 2000,\n    }\n  )\n\n  const posts = isLoading ? (\n    <div className="d-flex justify-content-center">\n      <div className="spinner-border" role="status">\n        <span className="sr-only"></span>\n      </div>\n    </div>\n  ) : isError ? (\n    <p>{error.message}</p>\n  ) : (\n    data?.map(post => (\n      <li key={post.id}>\n        <Link to={`/posts/${post.id}`}>{post.title}</Link>\n      </li>\n    ))\n  )\n\n  return (\n    <div className="col-8 col-md-6 mx-auto">\n      <h1>Blog Posts</h1>\n      {posts}\n    </div>\n  )\n}\n\nexport default Posts
\n

If we pass in a staleTime value of 2000 (in milliseconds), for example, then our query will remain marked as fresh for two seconds before being marked as stale. And the query will not get refetched on window refocus as long as it remains in fresh state.

\n

If we pass in staleTime of infinity, the query will never become stale.

\n
Learn how to fetch data using React Query in my blog post here.
\n","frontmatter":{"title":"Understanding staleTime in React Query","date":"2021-07-12"}}},"pageContext":{"slug":"/understanding-stale-time-in-react-query/","prev":{"fields":{"slug":"/difference-between-null-and-undefined-in-javascript/"},"frontmatter":{"modules":null}},"next":{"fields":{"slug":"/nullish-coalescing-operator-in-javascript/"},"frontmatter":{"modules":["JavaScript"]}}}}, "staticQueryHashes": ["3159585216"]}