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

Оператор keyof

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

keyof получает union ключей объектного типа. Например, keyof User превращается в "id" | "name" | "email".

Вопрос

Что делает оператор keyof?

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

type User = {
  id: number;
  name: string;
  email: string;
};
 
type UserKey = keyof User;
// "id" | "name" | "email"

Безопасный доступ к полю

function getValue<T, K extends keyof T>(object: T, key: K): T[K] {
  return object[key];
}
 
const user = { id: 1, name: "Анна" };
 
const name = getValue(user, "name");
// string

keyof не дает передать несуществующий ключ.

В mapped types

type Optional<T> = {
  [K in keyof T]?: T[K];
};

Так работает множество utility-типов.

С index signature

type Dictionary = {
  [key: string]: number;
};
 
type DictionaryKey = keyof Dictionary;
// string | number

Числа попадают в ключи из-за правил JavaScript: числовые ключи приводятся к строкам.

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

  • keyof T возвращает union ключей объектного типа.
  • Для типа с index signature [k: string] keyof дает string | number.
  • keyof typeof obj получает ключи из значения.
  • Пересечение с string (keyof T & string) убирает числовые и символьные ключи там, где нужны строки.

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

  • keyof T возвращает union ключей T.
  • Часто используется с K extends keyof T.
  • В mapped types перебирает поля объекта.
  • Вместе с T[K] дает точную типизацию доступа к свойствам.

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

TypeScript Handbook: Keyof Type Operator.

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

Поиск

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