Skip to main content

RequiredKeys<Original, Keys>

RequiredKeys<Original, Keys> = Omit<Original, Keys> & Required<Pick<Original, Keys>>

Creates a type where specified keys become required while others remain unchanged.

Type Parameters​

Original: Original​

The original object type.

Keys: Keys extends keyof Original​

The keys that should become required.

Since​

1.0.0

Example​

type User = {
  id: string;
  name?: string;     // Optional
  email?: string;    // Optional
  avatar?: string;   // Optional
};

// RequiredKeys<User, "name" | "email">
// Results in: { id: string; name: string; email: string; avatar?: string; }
type UserRequired = RequiredKeys<User, "name" | "email">;

const user: UserRequired = {
  id: "123",        // Required (unchanged)
  name: "John",     // Required (became required)
  email: "john@example.com", // Required (became required)
  // avatar remains optional (unchanged)
};