TS 类型：至少传一个属性 与 只允许传入一个属性

Posted 2023-01-19 GoldenaArcher

TS 类型：至少传一个属性 与 只允许传入一个属性

找到的 code snippet，正好符合需求

原文地址：typescript interface require one of two properties to exist

playground: Here is a TypeScript playground link showing both in action

原始答案：

type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<
  T,
  Exclude<keyof T, Keys>
> &
  
    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
  [Keys];

type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<
  T,
  Exclude<keyof T, Keys>
> &
  
    [K in Keys]-?: Required<Pick<T, K>> &
      Partial<Record<Exclude<Keys, K>, undefined>>;
  [Keys];

TS 3.5 更新：

type RequireAtLeastOne<T, R extends keyof T = keyof T> = Omit<T, R> &
   [P in R]: Required<Pick<T, P>> & Partial<Omit<T, P>> [R];

export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Omit<T, Keys> &
  
    [K in keyof Required<T>]: Required<Pick<T, K>> &
      Partial<Record<Exclude<Keys, K>, undefined>>;
  [Keys];