Skip to content
文档
全局配置

全局配置

SWRConfig 可以为所有的 SWR hook 提供全局配置 (选项)。

<SWRConfig value={options}>
  <Component/>
</SWRConfig>

在以下示例中,所有的 SWR hook 都将使用提供的相同的 fetcher 来加载 JSON 数据,默认每 3 秒刷新一次:

import useSWR, { SWRConfig } from 'swr'

function Dashboard () {
  const { data: events } = useSWR('/api/events')
  const { data: projects } = useSWR('/api/projects')
  const { data: user } = useSWR('/api/user', { refreshInterval: 0 }) // override

  // ...
}

function App () {
  return (
    <SWRConfig 
      value={{
        refreshInterval: 3000,
        fetcher: (resource, init) => fetch(resource, init).then(res => res.json())
      }}
    >
      <Dashboard />
    </SWRConfig>
  )
}

额外的 API

缓存 Provider

除去以上所列的 选项SWRConfig 还接受一个可选的 provider 函数。详细信息请参考 缓存 这一节。

<SWRConfig value={{ provider: () => new Map() }}>
  <Dashboard />
</SWRConfig>

访问全局配置

你可以使用 useSWRConfig hook 来获取全局配置,以及数据更改缓存

import { useSWRConfig } from 'swr'

function Component () {
  const { refreshInterval, mutate, cache, ...restConfig } = useSWRConfig()

  // ...
}

嵌套配置将会被扩展。如果没有使用 <SWRConfig>,将返回默认配置。