Skip to content
Документация
TypeScript

TypeScript

SWR дружелюбен к приложениям, написанным на TypeScript, с предустановленной типизацией.

Основное использование

По умолчанию SWR также выводит типы аргументов fetcher из key, так чтобы вам были доступны предпочтительные типы автоматически.

useSWR

// `key` подразумевается как `string`
useSWR('/api/user', key => {})
useSWR(() => '/api/user', key => {})
 
// `key` подразумевается как { a: string; b: { c: string; d: number } }
useSWR({ a: '1', b: { c: '3', d: 2 } }, key => {})
useSWR(() => ({ a: '1', b: { c: '3', d: 2 } }), key => {})
 
// `arg0` подразумевается как строка.  `arg1` подразумевается как число
useSWR(['user', 8], ([arg0, arg1]) => {})
useSWR(() => ['user', 8], ([arg0, arg1]) => {})

Вы также можете явно указать типы аргументов key и fetcher

import useSWR, { Fetcher } from 'swr'
 
const uid = '<user_id>'
const fetcher: Fetcher<User, string> = (id) => getUserById(id)
 
const { data } = useSWR(uid, fetcher)
// `data` будет `User | undefined`.

По умолчанию ошибка вызванная внутри функции fetcher имеет тип any. Тип также может быть указан явно.

const { data, error } = useSWR<User, Error>(uid, fetcher);
// `data` будет `User | undefined`.
// `error` будет `Error | undefined`.

useSWRInfinite

То же самое для swr/infinite, вы можете либо полагаться на автоматический вывод типа, либо явно указывать типы самостоятельно.

import { SWRInfiniteKeyLoader } from 'swr/infinite'
 
const getKey: SWRInfiniteKeyLoader = (index, previousPageData) => {
  // ...
}
 
const { data } = useSWRInfinite(getKey, fetcher)

useSWRSubscription

  • Inline subscribe function and mamually specify the type of next using SWRSubscriptionOptions.
import useSWRSubscription from 'swr/subscription'
import type { SWRSubscriptionOptions } from 'swr/subscription'
 
const { data, error } = useSWRSubscription('key', 
  (key, { next }: SWRSubscriptionOptions<number, Error>) => {
  //^ key will be inferred as `string`
  //....
  })
  return {
    data,
    //^ data will be inferred as `number | undefined`
    error
    //^ error will be inferred as `Error | undefined`
  }
}
  • declare subscribe function using SWRSubscription
import useSWRSubscription from 'swr/subscription'
import type { SWRSubscription } from 'swr/subscription'
 
/** 
 * The first generic is Key
 * The second generic is Data
 * The Third generic is Error
 */
const sub: SWRSubscription<string, number, Error> = (key, { next }) => {                         
  //......
}
const { data, error } = useSWRSubscription('key', sub)

Обобщения (Generics)

Указывать тип data легко. По умолчанию он будет использовать возвращаемый тип fetcher (с undefined для неготового состояния) в качестве типа data, но вы также можете передать его в качестве параметра:

// 🔹 A. Используйте типизированный fetcher:
// `getUser` является `(endpoint: string) => User`.
const { data } = useSWR('/api/user', getUser)
 
// 🔹 B. Укажите тип данных:
// `fetcher` обычно возвращает `any`.
const { data } = useSWR<User>('/api/user', fetcher)

Если вы хотите добавить типы для других параметров SWR, вы также можете напрямую импортировать эти типы:

import useSWR from 'swr'
import type { SWRConfiguration } from 'swr'
 
const config: SWRConfiguration = {
  fallbackData: "fallback",
  revalidateOnMount: false
  // ...
}
 
const { data } = useSWR<string[]>('/api/data', fetcher, config)

Типы промежуточного ПО

Есть несколько дополнительных определений типов, которые вы можете импортировать, чтобы упростить добавление типов в ваше пользовательское промежуточное ПО.

import useSWR, { Middleware, SWRHook } from 'swr'
 
const swrMiddleware: Middleware = (useSWRNext: SWRHook) => (key, fetcher, config) => {
  // ...
  return useSWRNext(key, fetcher, config)
}
Next.js SSG и SSRЗадержка (Suspense)