typescript - 是否可以有条件地要求 Typescript 接口(interface)中的属性

Question

假设我有以下界面:

interface updateOptions {
  updateAll: boolean;
  fields: string[];
}

有没有办法在未提供 Fields 时要求 updateAll，反之亦然，或者这是否必须在实现中有条件地完成？

Answer 1

使用标记联合类型:

type UpdateOptions =
  | {updateAll: true}
  | {updateAll: false, fields: string[]}

这样你只能初始化{updateAll: true} 或者{updateAll: false, fields: ['someField',/*...*/]}

从技术上讲，联合不需要有标签( bool updateAll)，但是你需要定义类型保护来测试在特定分支中使用的类型(我假设在你的代码中的某处你将执行 if (options.updateAll) {/* ... */}):

type UpdateAllOptions = {updateAll: true}
type UpdateSomeOptions = {fields: string[]}
type UpdateOptions = UpdateAllOptions | UpdateSomeOptions

// See https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
const isAllOptions = (options: UpdateOptions): options is UpdateAllOptions =>
  (options as any).updateAll === true