Pick w TypeScript: wybieranie właściwości z typu (przykłady)

Pick<T, K> to wbudowany typ narzędziowy, który tworzy typ obiektowy zawierający tylko właściwości T wymienione w K. Używaj go, gdy funkcja lub komponent potrzebuje kilku pól większego typu:

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 przyjmuje pełnego User, ale też zwykły obiekt { id, name }, bo prosi tylko o to, czego używa. Dzięki temu łatwiej ją wywołać i przetestować. Pick działa tylko na typach: pełny obiekt ada w czasie działania nadal ma wszystkie pięć właściwości.

Składnia i sprawdzanie kluczy

Pick<Type, Keys>

Keys to pojedynczy klucz lub unia kluczy, a każdy musi istnieć w Type. Definicja w bibliotece standardowej TypeScriptu zapisuje to jako ograniczenie:

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

Dzięki K extends keyof T błędnie wpisany lub nieistniejący klucz to błąd kompilacji, a edytor może podpowiadać nazwy kluczy:

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

Błąd to error TS2344: Type '"cost"' does not satisfy the constraint 'keyof Product'. To różnica względem Omit, którego klucze nie są sprawdzane.

Pick zachowuje readonly i opcjonalność

Pick mapuje po kluczach T, więc każda wybrana właściwość zachowuje swoje modyfikatory:

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 }

Ostatnia linia pokazuje { id: 8 }, bo readonly to tylko sprawdzenie podczas kompilacji: przypisanie zostało zgłoszone, wyciszone przez @ts-expect-error i mimo to wykonane. Aby zmienić modyfikatory przy wybieraniu, opakuj wynik: Partial<Pick<Account, "plan">> albo Required<Pick<Account, "email">>.

Pick a Omit

Pick wymienia, co zachować; Omit wymienia, co odrzucić. Dziś oba dają ten sam wynik, ale zachowują się inaczej, gdy typ źródłowy się rozrasta:

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 }

Dla danych, które opuszczają twój serwer, Pick to bezpieczniejszy wybór domyślny: nic nie pojawi się w typie, jeśli ktoś celowo tego nie doda.

Wybieranie z typów zagnieżdżonych

Pick widzi tylko klucze najwyższego poziomu: ścieżka z kropką, taka jak Pick<Customer, "address.city">, to błąd (TS2344), a nie zagnieżdżony wybór. Użyj indexed access type, żeby sięgnąć do zagnieżdżonego typu, i wybieraj z niego:

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"] to typ właściwości address. Ta sama składnia sięga do elementów tablicy: dla właściwości orders: Order[] Customer["orders"][number] to Order.

Otypowana funkcja pick()

Pick nic nie robi w czasie działania. Mała funkcja generyczna kopiuje wybrane właściwości do nowego obiektu i zwraca dokładnie 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 pozwala TypeScriptowi wywnioskować K z argumentów tekstowych, więc typ zwracany ma dokładnie wybrane klucze. Asercja {} as Pick<T, K> jest potrzebna, bo pusty obiekt jeszcze nie ma tych właściwości; pętla je uzupełnia.

Wybieranie właściwości według typu wartości

Pick wybiera po nazwie klucza. Aby wybierać według typu właściwości, na przykład "wszystkie pola tekstowe", napisz typ mapowany z filtrem kluczy:

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 }

Klauzula as mapuje każdy klucz na niego samego, gdy jego typ pasuje, a w przeciwnym razie na never, a klucze never są odrzucane. Jeden niuans: typ właściwości opcjonalnej zawiera undefined, więc opcjonalne subtitle?: string nie liczyłoby się tu jako string; testuj względem string | undefined, żeby je uwzględnić.