Typescript Make Some Key Optional

tylim88

Acid Coder

Posted on June 6, 2022

Typescript Make Some Key Optional

How to make specific keys optional, hard mode(without any utilities)

type ExcludeKey<T extends Record<string,unknown>, U extends keyof T>={
  [K in keyof T as K extends U ? never : K]: T[K]
} 

type MakeKeyOptional<T extends Record<string,unknown>, U extends keyof T>=ExcludeKey<T,U> & {[K in U]?:T[K]}

type A = MakeKeyOptional<{a:1,b:2,c:3},"b"|"c">

const a1:A = {a:1} // ok!
const a2:A = {a:1,b:2} // ok!
const a3:A = {a:1,b:2,c:3} // ok!
const a4:A = {b:2,c:3} // expect error!
Enter fullscreen mode Exit fullscreen mode

playground

easy mode (with utilities)

type MakeKeyOptional<T extends Record<string, unknown>, U extends keyof T> =
  Omit<T, U> & Partial<Pick<T, U>>;
Enter fullscreen mode Exit fullscreen mode
💖 💪 🙅 🚩
tylim88
Acid Coder

Posted on June 6, 2022

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related