Pick di TypeScript: Memilih Property dari Tipe (Contoh)

Pick<T, K> adalah utility type bawaan yang membuat object type yang hanya berisi property T yang disebut di K. Pakai saat sebuah fungsi atau komponen hanya butuh beberapa field dari tipe yang lebih besar:

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 menerima User yang lengkap dan juga object { id, name } biasa, karena ia hanya meminta apa yang dipakainya. Itu membuatnya lebih mudah dipanggil dan diuji. Pick hanya ada di level tipe: object ada yang lengkap tetap punya kelima property saat runtime.

Sintaks dan Pengecekan Key

Pick<Type, Keys>

Keys adalah satu key atau union dari beberapa key, dan setiap key harus ada di Type. Definisinya di standard library TypeScript menjadikan hal itu sebuah batasan:

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

Karena K extends keyof T, key yang salah eja atau tidak ada menjadi error kompilasi, dan editormu bisa melengkapi nama key secara otomatis:

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-nya adalah error TS2344: Type '"cost"' does not satisfy the constraint 'keyof Product'. Ini perbedaannya dengan Omit, yang key-nya tidak dicek.

Pick Mempertahankan readonly dan Opsional

Pick melakukan mapping atas key milik T, jadi setiap property yang dipilih tetap membawa modifier-nya:

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 }

Baris terakhir menampilkan { id: 8 } karena readonly hanya pengecekan saat kompilasi: assignment itu dilaporkan, diredam dengan @ts-expect-error, dan tetap dijalankan. Untuk mengubah modifier sambil memilih, bungkus hasilnya: Partial<Pick<Account, "plan">> atau Required<Pick<Account, "email">>.

Pick vs Omit

Pick menyebut apa yang dipertahankan; Omit menyebut apa yang dibuang. Saat ini keduanya memberi hasil yang sama, tetapi perilakunya berbeda saat tipe sumbernya bertambah:

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 }

Untuk data yang keluar dari server-mu, Pick adalah pilihan default yang lebih aman: tidak ada yang muncul di tipe kecuali seseorang sengaja menambahkannya.

Memilih dari Tipe Bersarang

Pick hanya melihat key di level teratas: path bertitik seperti Pick<Customer, "address.city"> adalah error (TS2344), bukan pemilihan bersarang. Pakai indexed access type untuk mencapai tipe bersarangnya, lalu pilih dari situ:

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"] adalah tipe dari property address. Sintaks yang sama bisa mencapai elemen array: untuk property orders: Order[], Customer["orders"][number] adalah Order.

Fungsi pick() Bertipe

Pick tidak melakukan apa pun saat runtime. Fungsi generic kecil menyalin property yang dipilih ke object baru dan mengembalikan tepat 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 membuat TypeScript menyimpulkan K dari argumen string, sehingga tipe kembaliannya punya tepat key yang dipilih. Assertion {} as Pick<T, K> diperlukan karena object kosong belum punya property itu; perulangannya yang mengisinya.

Memilih Property Berdasarkan Tipe Nilainya

Pick memilih berdasarkan nama key. Untuk memilih berdasarkan tipe property, misalnya "semua field string", tulis mapped type dengan filter key:

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 }

Klausa as memetakan setiap key ke dirinya sendiri kalau tipenya cocok, dan ke never kalau tidak, lalu key never dibuang. Satu hal halus: tipe property opsional memuat undefined, jadi subtitle?: string yang opsional tidak dihitung sebagai string di sini; uji terhadap string | undefined untuk menyertakannya.