Pick в TypeScript: выбрать свойства из типа, примеры

Pick<T, K> это встроенный служебный тип, который создаёт объектный тип только из свойств T, названных в K. Используйте его, когда функции или компоненту нужны несколько полей большего типа:

interface User {
  id: number;
  name: string;
  email: string;
  passwordHash: string;
  lastLogin: string;
}

type UserPreview = Pick<User, "id" | "name">;
// { id: number; name: string }

function renderPreview(user: UserPreview): string {
  return `#${user.id} ${user.name}`;
}

const ada: User = {
  id: 1, name: "Ada", email: "ada@example.com",
  passwordHash: "x9f...", lastLogin: "2024-03-15",
};

console.log(renderPreview(ada));                  // #1 Ada
console.log(renderPreview({ id: 2, name: "Linus" })); // #2 Linus

renderPreview принимает и полный User, и обычный объект { id, name }, потому что просит только то, что использует. Такую функцию проще вызывать и тестировать. Pick существует только в типах: во время выполнения у полного объекта ada по-прежнему все пять свойств.

Синтаксис и проверка ключей

Pick<Type, Keys>

Keys это один ключ или объединение ключей, и каждый из них должен существовать в Type. Определение в стандартной библиотеке TypeScript делает это ограничением:

type Pick<T, K extends keyof T> = {
  [P in K]: T[P];
};

Благодаря K extends keyof T ключ с опечаткой или отсутствующий ключ это ошибка компиляции, а редактор может автодополнять имена ключей:

interface Product {
  sku: string;
  title: string;
  price: number;
  stock: number;
}

type PriceTag = Pick<Product, "title" | "price">;

const tag: PriceTag = { title: "Lamp", price: 39 };
console.log(`${tag.title}: $${tag.price}`); // Lamp: $39

// @ts-expect-error: Type '"cost"' does not satisfy the constraint 'keyof Product'
type Broken = Pick<Product, "cost">;

Ошибка выглядит так: error TS2344: Type '"cost"' does not satisfy the constraint 'keyof Product'. В этом отличие от Omit, ключи которого не проверяются.

Pick сохраняет readonly и необязательность

Pick перебирает ключи T, поэтому каждое выбранное свойство сохраняет свои модификаторы:

interface Account {
  readonly id: number;
  email?: string;
  plan: "free" | "pro";
}

type AccountRef = Pick<Account, "id" | "email">;
// { readonly id: number; email?: string }

const ref: AccountRef = { id: 7 }; // email is still optional
// @ts-expect-error: Cannot assign to 'id' because it is a read-only property
ref.id = 8;

console.log(ref); // { id: 8 }

Последняя строка показывает { id: 8 }, потому что readonly это только проверка времени компиляции: о присваивании было сообщено, оно подавлено через @ts-expect-error и всё равно выполнилось. Чтобы изменить модификаторы при выборе, оберните результат: Partial<Pick<Account, "plan">> или Required<Pick<Account, "email">>.

Pick и Omit

Pick называет то, что оставить; Omit называет то, что убрать. Сегодня оба дают одинаковый результат, но ведут себя по-разному, когда исходный тип растёт:

interface Order {
  id: number;
  total: number;
  cardLast4: string;
  // added later: internalNotes: string;
}

type Receipt = Pick<Order, "id" | "total">;   // stays { id; total }
type AdminView = Omit<Order, "cardLast4">;    // will include internalNotes too

const receipt: Receipt = { id: 1, total: 49.9 };
const admin: AdminView = { id: 1, total: 49.9 };
console.log(receipt, admin); // { id: 1, total: 49.9 } { id: 1, total: 49.9 }

Для данных, покидающих ваш сервер, Pick безопаснее по умолчанию: в типе ничего не появится, если кто-то не добавит это намеренно.

Выбор из вложенных типов

Pick видит только ключи верхнего уровня: путь через точку вроде Pick<Customer, "address.city"> это ошибка (TS2344), а не вложенный выбор. Используйте тип доступа по индексу, чтобы добраться до вложенного типа, а затем выбирайте из него:

interface Customer {
  id: number;
  name: string;
  address: {
    street: string;
    city: string;
    country: string;
  };
}

type City = Pick<Customer["address"], "city">; // { city: string }

// Keep the shape, trim the nested object
type ShippingLabel = Pick<Customer, "name"> & {
  address: Pick<Customer["address"], "city" | "country">;
};

const label: ShippingLabel = {
  name: "Ada",
  address: { city: "London", country: "UK" },
};

const city: City = { city: label.address.city };
console.log(label, city.city);
// { name: 'Ada', address: { city: 'London', country: 'UK' } } London

Customer["address"] это тип свойства address. Тот же синтаксис добирается до элементов массива: для свойства orders: Order[] тип Customer["orders"][number] это Order.

Типизированная функция pick()

Pick ничего не делает во время выполнения. Небольшая обобщённая функция копирует выбранные свойства в новый объект и возвращает ровно Pick<T, K>:

function pick<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Pick<T, K> {
  const result = {} as Pick<T, K>;
  for (const key of keys) {
    result[key] = obj[key];
  }
  return result;
}

const book = { id: 3, title: "Dune", author: "Herbert", pages: 412 };

const summary = pick(book, "title", "author"); // { title: string; author: string }
console.log(summary);          // { title: 'Dune', author: 'Herbert' }
console.log(Object.keys(summary)); // [ 'title', 'author' ]
// pick(book, "isbn") would be error TS2345: Argument of type '"isbn"' is not assignable
// to parameter of type '"author" | "id" | "pages" | "title"'.

K extends keyof T позволяет TypeScript вывести K из строковых аргументов, поэтому у типа возврата ровно выбранные ключи. Утверждение {} as Pick<T, K> нужно потому, что у пустого объекта этих свойств ещё нет; цикл их заполняет.

Выбор свойств по типу значения

Pick выбирает по имени ключа. Чтобы выбирать по типу свойства, например «все строковые поля», напишите сопоставленный тип с фильтром ключей:

type PickByValue<T, V> = {
  [P in keyof T as T[P] extends V ? P : never]: T[P];
};

interface Article {
  id: number;
  title: string;
  slug: string;
  views: number;
  published: boolean;
}

type TextFields = PickByValue<Article, string>;   // { title: string; slug: string }
type NumberFields = PickByValue<Article, number>; // { id: number; views: number }

const text: TextFields = { title: "Hello", slug: "hello" };
const nums: NumberFields = { id: 1, views: 120 };
console.log(text, nums); // { title: 'Hello', slug: 'hello' } { id: 1, views: 120 }

Конструкция as сопоставляет каждый ключ с самим собой, если его тип подходит, и с never в противном случае, а ключи never отбрасываются. Одна тонкость: тип необязательного свойства включает undefined, поэтому необязательный subtitle?: string здесь не будет считаться string; чтобы включить его, проверяйте на string | undefined.