re:re:actable
Урок 031 минута чтения

Типизация асинхронных функций

На этой странице
Кратко

async-функция всегда возвращает Promise. Поэтому тип результата записывают как Promise<T>, где T - значение после await.

Вопрос

Как типизировать функцию, которая возвращает Promise?

Базовый пример

type User = {
  id: number;
  name: string;
};
 
async function fetchUser(id: number): Promise<User> {
  const response = await fetch(`/users/${id}`);
  return response.json();
}

Даже если внутри возвращается обычный объект, async оборачивает его в Promise.

async function getCount(): Promise<number> {
  return 10;
}

Promise без async

function fetchUserRaw(id: number): Promise<User> {
  return fetch(`/users/${id}`).then((response) => response.json());
}

Promise<void>

Если асинхронная функция ничего значимого не возвращает, используют Promise<void>.

async function saveSettings(): Promise<void> {
  await fetch("/settings", { method: "POST" });
}

Generic для API-клиента

async function getJSON<T>(url: string): Promise<T> {
  const response = await fetch(url);
  return response.json() as Promise<T>;
}
 
const user = await getJSON<User>("/user");

Ошибки лучше ловить как unknown

try {
  await fetchUser(1);
} catch (error: unknown) {
  if (error instanceof Error) {
    console.error(error.message);
  }
}

Что важно помнить

  • Async-функция всегда возвращает Promise<T>; в аннотации пишут Promise<User>, а не User.
  • response.json() возвращает Promise<any> — результат стоит валидировать или хотя бы присвоить unknown.
  • Awaited<T> разворачивает промис на уровне типов: Awaited<ReturnType<typeof load>>.
  • Ошибки промиса не типизируются: в catch всегда unknown.

Мини-шпаргалка

  • async function fn(): Promise<T>.
  • await достает T из Promise<T>.
  • Без результата: Promise<void>.
  • Для неизвестного ответа API часто используют generic.

Документация

TypeScript Handbook: Promise, TypeScript: Awaited.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам