vercel · oosawy · May 5, 2025 · May 5, 2025
@@ -0,0 +1,30 @@
+# Basic
+
+## One-Click Deploy
+
+Deploy your own SWR project with Vercel.
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?s=https://github.com/vercel/swr/tree/main/examples/suspense)
+
+## How to Use
+
+Download the example:
+
+```bash
+curl https://codeload.github.com/vercel/swr/tar.gz/main | tar -xz --strip=2 swr-main/examples/suspense
+cd suspense
+```
+
+Install it and run:
+
+```bash
+yarn
+yarn dev
+# or
+npm install
+npm run dev
+```
+
+## The Idea behind the Example
+
+Show how to use the SWR suspense option with React suspense.
@@ -0,0 +1,17 @@
+import React from 'react'
+
+export default class ErrorBoundary extends React.Component<any> {
+  state = { hasError: false, error: null }
+  static getDerivedStateFromError(error: any) {
+    return {
+      hasError: true,
+      error
+    }
+  }
+  render() {
+    if (this.state.hasError) {
+      return this.props.fallback
+    }
+    return this.props.children
+  }
+}
@@ -0,0 +1,24 @@
+'use client'
+
+import { SWRConfig } from 'swr'
+
+import fetcher from './libs/fetch'
+
+declare module 'swr' {
+  interface SWRGlobalConfig {
+    suspense: true
+  }
+}
+
+export function GlobalSWRConfig({ children }: { children: React.ReactNode }) {
+  return (
+    <SWRConfig
+      value={{
+        fetcher,
+        suspense: true
+      }}
+    >
+      {children}
+    </SWRConfig>
+  )
+}
@@ -0,0 +1,8 @@
+export default async function fetcher(...args: [any]) {
+  const res = await fetch(...args)
+  if (!res.ok) {
+    throw new Error('An error occurred while fetching the data.')
+  } else {
+    return res.json()
+  }
+}
@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
@@ -0,0 +1,17 @@
+{
+  "name": "suspense-global",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "next": "latest",
+    "react": "latest",
+    "react-dom": "latest",
+    "swr": "latest"
+  },
+  "scripts": {
+    "dev": "next",
+    "start": "next start",
+    "build": "next build"
+  }
+}
@@ -0,0 +1,30 @@
+import dynamic from 'next/dynamic'
+import Link from 'next/link'
+import { Suspense } from 'react'
+import ErrorHandling from '../../components/error-handling'
+import { useRouter } from 'next/router'
+
+const Detail = dynamic(() => import('./detail'), {
+  ssr: false
+})
+
+export default function Repo() {
+  const router = useRouter()
+  if (!router.isReady) return null
+  const { user, repo } = router.query
+  const id = `${user}/${repo}`
+
+  return (
+    <div style={{ textAlign: 'center' }}>
+      <h1>{id}</h1>
+      <Suspense fallback={<div>loading...</div>}>
+        <ErrorHandling fallback={<div>oooops!</div>}>
+          <Detail id={id}></Detail>
+        </ErrorHandling>
+      </Suspense>
+      <br />
+      <br />
+      <Link href="/">Back</Link>
+    </div>
+  )
+}
@@ -0,0 +1,20 @@
+import useSWR from 'swr'
+import { RepoData } from '../api/data'
+
+const Detail = ({ id }: { id: string }) => {
+  const { data } = useSWR<RepoData>('/api/data?id=' + id)
+
+  return (
+    <>
+      {data ? (
+        <div>
+          <p>forks: {data.forks_count}</p>
+          <p>stars: {data.stargazers_count}</p>
+          <p>watchers: {data.watchers}</p>
+        </div>
+      ) : null}
+    </>
+  )
+}
+
+export default Detail
@@ -0,0 +1,10 @@
+import type { AppProps } from 'next/app'
+import { GlobalSWRConfig } from 'global-swr-config'
+
+export default function MyApp({ Component, pageProps }: AppProps) {
+  return (
+    <GlobalSWRConfig>
+      <Component {...pageProps} />
+    </GlobalSWRConfig>
+  )
+}
@@ -0,0 +1,40 @@
+import { NextApiRequest, NextApiResponse } from 'next'
+
+const projects = [
+  'facebook/flipper',
+  'vuejs/vuepress',
+  'rust-lang/rust',
+  'vercel/next.js',
+  'emperor/clothes'
+] as const
+
+export type ProjectsData = typeof projects
+
+export interface RepoData {
+  forks_count: number
+  stargazers_count: number
+  watchers: number
+}
+
+export default function api(req: NextApiRequest, res: NextApiResponse) {
+  if (req.query.id) {
+    if (req.query.id === projects[4]) {
+      setTimeout(() => {
+        res.status(404).json({ msg: 'not found' })
+      })
+    } else {
+      // a slow endpoint for getting repo data
+      fetch(`https://api.github.com/repos/${req.query.id}`)
+        .then(res => res.json())
+        .then(data => {
+          setTimeout(() => {
+            res.json(data)
+          }, 2000)
+        })
+    }
+  } else {
+    setTimeout(() => {
+      res.json(projects)
+    }, 2000)
+  }
+}
@@ -0,0 +1,17 @@
+import { Suspense } from 'react'
+import dynamic from 'next/dynamic'
+
+const Repos = dynamic(() => import('./repos'), {
+  ssr: false
+})
+
+export default function Index() {
+  return (
+    <div style={{ textAlign: 'center' }}>
+      <h1>Trending Projects</h1>
+      <Suspense fallback={<div>loading...</div>}>
+        <Repos />
+      </Suspense>
+    </div>
+  )
+}
@@ -0,0 +1,22 @@
+import Link from 'next/link'
+import { ProjectsData } from './api/data'
+
+import useSWR from 'swr'
+
+const Repos = () => {
+  const { data } = useSWR<ProjectsData>('/api/data')
+
+  return (
+    <>
+      {data.map(project => (
+        <p key={project}>
+          <Link href="/[user]/[repo]" as={`/${project}`}>
+            {project}
+          </Link>
+        </p>
+      ))}
+    </>
+  )
+}
+
+export default Repos
@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "noImplicitAny": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "baseUrl": ".",
+    "paths": {
+      "~/*": ["./*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
@@ -108,7 +108,7 @@
     "lint": "eslint . --ext .ts,.tsx --cache",
     "lint:fix": "pnpm lint --fix",
     "coverage": "jest --coverage",
-    "test-typing": "tsc --noEmit -p test/type/tsconfig.json && tsc --noEmit -p test/tsconfig.json",
+    "test-typing": "tsc -p test/tsconfig.json && tsc -p test/type/tsconfig.json && tsc -p test/type/suspense/tsconfig.json",
     "test": "jest",
     "test:build": "jest --config jest.config.build.js",
     "test:e2e": "playwright test",

@@ -1,3 +1,4 @@
+import type { SWRGlobalConfig } from '../index'
 import type * as revalidateEvents from './events'
 
 export type GlobalState = [
@@ -33,7 +34,9 @@ export type ReactUsePromise<T = unknown, Error = unknown> = Promise<any> & {
 export type BlockingData<
   Data = any,
   Options = SWROptions<Data>
-> = Options extends undefined
+> = SWRGlobalConfig extends { suspense: true }
+  ? true
+  : Options extends undefined
   ? false
   : Options extends { suspense: true }
   ? true
@@ -456,7 +459,11 @@ export type SWRConfiguration<
 export type IsLoadingResponse<
   Data = any,
   Options = SWROptions<Data>
-> = Options extends { suspense: true } ? false : boolean
+> = SWRGlobalConfig extends { suspense: true }
+  ? Options extends { suspense: true }
+    ? false
+    : false
+  : boolean
 
 type SWROptions<Data> = SWRConfiguration<Data, Error, Fetcher<Data, Key>>
 type SWRConfigurationWithOptionalFallback<Options> =

@@ -8,6 +8,12 @@ export { useSWRConfig } from '../_internal'
 export { mutate } from '../_internal'
 export { preload } from '../_internal'
 
+// Config
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SWRGlobalConfig {
+  // suspense: true
+}
+
 // Types
 export type {
   SWRConfiguration,

@@ -1,6 +1,7 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
+    "noEmit": true,
     "strict": false,
     "jsx": "react-jsx",
     "baseUrl": "..",
@@ -10,8 +11,8 @@
       "swr/immutable": ["./immutable/src/index.ts"],
       "swr/mutation": ["./mutation/src/index.ts"],
       "swr/_internal": ["./_internal/src/index.ts"],
-      "swr/subscription": ["subscription/src/index.ts"],
-    },
+      "swr/subscription": ["subscription/src/index.ts"]
+    }
   },
   "include": [".", "./jest-setup.ts"],
   "exclude": ["./type"]

@@ -0,0 +1,19 @@
+import type { BlockingData } from 'swr/_internal'
+import { expectType } from '../utils'
+
+declare module 'swr' {
+  interface SWRGlobalConfig {
+    suspense: true
+  }
+}
+
+export function testDataCached() {
+  expectType<BlockingData<string, { fallbackData: string }>>(true)
+  expectType<BlockingData<any, { suspense: true }>>(true)
+  expectType<
+    BlockingData<string, { fallbackData?: string; revalidate: boolean }>
+  >(true)
+  expectType<BlockingData<false, { suspense: false; revalidate: boolean }>>(
+    true
+  )
+}
@@ -0,0 +1,13 @@
+import useSWR from 'swr'
+import { expectType } from '../utils'
+
+declare module 'swr' {
+  interface SWRGlobalConfig {
+    suspense: true
+  }
+}
+
+export function testSuspense() {
+  const { data } = useSWR('/api', (k: string) => Promise.resolve(k))
+  expectType<string>(data)
+}
@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "strict": true,
+    "jsx": "react-jsx"
+  },
+  "include": ["./**/*.ts", "./**/*.tsx"],
+  "exclude": []
+}