Pick in TypeScript: selezionare proprietà da un tipo

Pick<T, K> è un utility type integrato che crea un tipo oggetto con le sole proprietà di T nominate in K. Usalo quando una funzione o un componente ha bisogno di pochi campi di un tipo più grande:

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 accetta un User completo e anche un semplice oggetto { id, name }, perché chiede solo ciò che usa. Così è più facile da chiamare e da testare. Pick agisce solo sui tipi: l'oggetto completo ada ha ancora tutte e cinque le proprietà in fase di esecuzione.

Sintassi e controllo delle chiavi

Pick<Type, Keys>

Keys è una singola chiave o un'unione di chiavi, e ognuna deve esistere in Type. La definizione nella libreria standard di TypeScript lo rende un vincolo:

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

Grazie a K extends keyof T, una chiave scritta male o inesistente è un errore di compilazione, e l'editor può completare automaticamente i nomi delle chiavi:

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

L'errore è error TS2344: Type '"cost"' does not satisfy the constraint 'keyof Product'. È una differenza rispetto a Omit, le cui chiavi non vengono controllate.

Pick mantiene readonly e opzionale

Pick itera sulle chiavi di T, quindi ogni proprietà selezionata mantiene i suoi modificatori:

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 }

L'ultima riga mostra { id: 8 } perché readonly è solo un controllo in fase di compilazione: l'assegnazione è stata segnalata, soppressa con @ts-expect-error, ed è stata comunque eseguita. Per cambiare i modificatori mentre selezioni, avvolgi il risultato: Partial<Pick<Account, "plan">> o Required<Pick<Account, "email">>.

Pick vs Omit

Pick nomina ciò che va tenuto; Omit nomina ciò che va tolto. Oggi entrambi danno lo stesso risultato, ma si comportano in modo diverso quando il tipo di origine cresce:

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 }

Per i dati che escono dal tuo server, Pick è la scelta predefinita più sicura: nel tipo non compare nulla a meno che qualcuno non l'abbia aggiunto di proposito.

Selezionare da tipi annidati

Pick vede solo le chiavi di primo livello: un percorso con i punti come Pick<Customer, "address.city"> è un errore (TS2344), non una selezione annidata. Usa un indexed access type per raggiungere il tipo annidato, poi seleziona da quello:

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"] è il tipo della proprietà address. La stessa sintassi raggiunge gli elementi degli array: per una proprietà orders: Order[], Customer["orders"][number] è Order.

Una funzione pick() tipizzata

Pick non fa nulla in fase di esecuzione. Una piccola funzione generica copia le proprietà scelte in un nuovo oggetto e restituisce esattamente 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 permette a TypeScript di inferire K dagli argomenti stringa, quindi il tipo di ritorno ha esattamente le chiavi selezionate. L'asserzione {} as Pick<T, K> serve perché un oggetto vuoto non ha ancora quelle proprietà; il ciclo le riempie.

Selezionare proprietà in base al tipo del valore

Pick seleziona per nome della chiave. Per selezionare in base al tipo della proprietà, per esempio "tutti i campi stringa", scrivi un mapped type con un filtro sulle chiavi:

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 }

La clausola as mappa ogni chiave su sé stessa quando il suo tipo corrisponde e su never altrimenti, e le chiavi never vengono scartate. Una sottigliezza: il tipo di una proprietà opzionale include undefined, quindi un subtitle?: string opzionale qui non conterebbe come string; confrontalo con string | undefined per includerlo.