re:re:actable
Урок 043 минуты чтения

Как описать тип функции через type и interface

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

Тип функции записывают стрелочной нотацией в type: type Handler = (event: Event) => void. В interface используют call signature: { (value: string): boolean } — так можно описать функцию с дополнительными свойствами. Методы в объектных типах пишут как method(): void или как свойство-функцию method: () => void; они по-разному проверяются при strictFunctionTypes.

Вопрос

Как указать тип функции в интерфейсе или type? Как создать тип функции через type и чем это отличается от метода?

Через type

type Compare<T> = (a: T, b: T) => number;
type Predicate = (value: unknown) => boolean;
type AsyncLoader<T> = (id: string) => Promise<T>;
 
const byPrice: Compare<{ price: number }> = (a, b) => a.price - b.price;

Аннотация переменной типом функции позволяет не писать типы параметров — они выводятся из типа.

Через interface: call signature

interface Formatter {
  (value: number): string;      // функцию можно вызвать
  locale: string;               // и у нее есть свойство
}
 
const formatPrice = ((value: number) => `${value} ₽`) as Formatter;
formatPrice.locale = "ru";

Construct signature описывает то, что вызывается через new:

interface UserConstructor {
  new (name: string): User;
}

Функции как поля объекта

interface Api {
  getUser(id: string): Promise<User>;          // синтаксис метода
  onError: (error: Error) => void;             // свойство-функция
  log?: (message: string) => void;             // необязательная функция
}
Метод m(): voidСвойство m: () => void
Проверка параметров при strictFunctionTypesбивариантная (мягче)контравариантная (строже)
Перегрузкиможно объявить несколько сигнатурчерез пересечение функций
Рекомендациядля методов классов и APIдля колбэков, строгая безопасность

Правило @typescript-eslint/method-signature-style помогает выбрать единый стиль.

Типизация колбэков и props

type ButtonProps = {
  onClick: (event: React.MouseEvent<HTMLButtonElement>) => void;
  onHover?: () => void;
};
 
function useDebounce<T extends (...args: never[]) => unknown>(fn: T, delay: number) {}

Получение типа существующей функции

function createUser(name: string, age: number) {
  return { id: crypto.randomUUID(), name, age };
}
 
type CreateUser = typeof createUser;               // (name: string, age: number) => {...}
type Args = Parameters<typeof createUser>;          // [name: string, age: number]
type Result = ReturnType<typeof createUser>;        // { id: string; name: string; age: number }

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

  • Не используйте тип Function: он принимает любую функцию и возвращает any.
  • Для «любой функции» безопаснее (...args: never[]) => unknown.
  • Тип () => void разрешает передать функцию, которая что-то возвращает, — результат игнорируется.
  • Имена параметров в типе функции не обязаны совпадать с реализацией, но помогают читать код.

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

  • type Fn = (a: A) => R — основной способ.
  • interface { (a: A): R } — call signature, функция со свойствами.
  • new (...) => T — construct signature.
  • Метод m(): R мягче проверяется, чем свойство m: () => R.
  • typeof fn, Parameters, ReturnType — тип из существующей функции.

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

TypeScript Handbook: Function Type Expressions, TypeScript Handbook: Call Signatures.

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

Поиск

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