TypeScript Pick: Bir Tipten Özellik Seçmek (Örnekler)

Pick<T, K>, T tipinin yalnızca K içinde adı geçen özelliklerini içeren bir nesne tipi oluşturan yerleşik bir utility type'tır. Bir fonksiyon ya da bileşen daha büyük bir tipin birkaç alanına ihtiyaç duyduğunda kullanın:

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 hem eksiksiz bir User hem de düz bir { id, name } nesnesi kabul eder, çünkü yalnızca kullandığı şeyi ister. Bu onu çağırmayı ve test etmeyi kolaylaştırır. Pick yalnızca tip düzeyindedir: eksiksiz ada nesnesi çalışma zamanında hâlâ beş özelliğin hepsine sahiptir.

Sözdizimi ve Anahtar Kontrolü

Pick<Type, Keys>

Keys tek bir anahtar ya da anahtarlardan oluşan bir union'dır ve her biri Type üzerinde var olmalıdır. TypeScript'in standart kütüphanesindeki tanım bunu bir kısıtlama hâline getirir:

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

K extends keyof T sayesinde yanlış yazılmış ya da eksik bir anahtar derleme hatasıdır ve editörünüz anahtar adlarını otomatik tamamlayabilir:

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">;

Hata şudur: error TS2344: Type '"cost"' does not satisfy the constraint 'keyof Product'. Anahtarları kontrol edilmeyen Omit ile fark budur.

Pick readonly ve İsteğe Bağlılığı Korur

Pick, T tipinin anahtarları üzerinde eşleme yapar, bu yüzden seçilen her özellik değiştiricilerini korur:

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 }

Son satır { id: 8 } gösterir, çünkü readonly yalnızca derleme zamanında yapılan bir kontroldür: atama bildirildi, @ts-expect-error ile bastırıldı ve yine de çalıştı. Seçerken değiştiricileri değiştirmek için sonucu sarın: Partial<Pick<Account, "plan">> ya da Required<Pick<Account, "email">>.

Pick ve Omit

Pick neyin tutulacağını, Omit neyin atılacağını adlandırır. Bugün ikisi aynı sonucu verir, ama kaynak tip büyüdüğünde farklı davranırlar:

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 }

Sunucunuzdan dışarı çıkan veri için Pick daha güvenli varsayılandır: biri bilerek eklemedikçe tipte hiçbir şey görünmez.

İç İçe Tiplerden Seçmek

Pick yalnızca en üst düzey anahtarları görür: Pick<Customer, "address.city"> gibi noktalı bir yol iç içe bir seçim değil, bir hatadır (TS2344). İç içe tipe ulaşmak için bir indexed access type kullanın, sonra ondan seçin:

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 özelliğinin tipidir. Aynı sözdizimi dizi elemanlarına da ulaşır: bir orders: Order[] özelliği için Customer["orders"][number] tipi Order olur.

Tipli Bir pick() Fonksiyonu

Pick çalışma zamanında hiçbir şey yapmaz. Küçük bir generic fonksiyon seçilen özellikleri yeni bir nesneye kopyalar ve tam olarak Pick<T, K> döndürür:

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'in K tipini string argümanlardan çıkarmasını sağlar; böylece dönüş tipi tam olarak seçilen anahtarlara sahip olur. {} as Pick<T, K> assertion'ı gereklidir, çünkü boş bir nesne henüz bu özelliklere sahip değildir; döngü onları doldurur.

Özellikleri Değer Tipine Göre Seçmek

Pick anahtar adına göre seçer. Özelliğin tipine göre seçmek için, örneğin "tüm string alanlar", anahtar filtresi olan bir mapped type yazın:

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 ifadesi, tipi eşleşen her anahtarı kendisine, diğerlerini ise never tipine eşler ve never anahtarlar atılır. İnce bir nokta: isteğe bağlı bir özelliğin tipi undefined içerir, bu yüzden isteğe bağlı bir subtitle?: string burada string sayılmaz; onu dahil etmek için string | undefined tipine karşı test edin.