打字稿：属性的类型依赖于同一对象中的另一个属性

Question

我有一个带有两个属性的 TypeScript 接口（ type:string和args:object ）。 args可能具有不同的属性，具体取决于type 。 我需要对args应用什么类型定义，以便编译器/自动完成将知道args允许哪些属性？

这有点类似于我在 Redux 中使用 Actions 的方式，它有一个type和一个payload ，在我的减速器中，编译器通过 switch 语句知道有效负载包含什么。 但我不能让它与我的对象一起工作。 我在这里阅读了一篇很棒的文章https://artsy.github.io/blog/2018/11/21/conditional-types-in-typescript/但这描述了具有两个相互依赖的 args 的方法的问题，但是不是如何让这对同一对象中的两个属性起作用。

export interface IObject {
  type: ObjectType
  parameters: ObjectParameters
}

export type ObjectType = "check" | "counter"

export interface IParametersCheck {
  checked: boolean
}

export interface IParametersCounter {
  max: number
  min: number
  step: number
}

export type ObjectParameters = IParametersCheck | IParametersCounter

如果我有一个IObject并将类型设置为“检查”，编译器/自动完成应该提供IParametersCheck的属性。

Answer 1

我认为您实际上正在寻找的是一个受歧视的工会。 IObject本身应该是一个联合：

export type IObject = {
    type: "checked"
    parameters: IParametersCheck
} | {
    type: "counter"
    parameters: IParametersCounter
}
export type ObjectType = IObject['type'] //// in case you need this union
export type ObjectParameters = IObject['parameters']  //// in case you need this union

export interface IParametersCheck {
    checked: boolean
}
export interface IParametersCounter {
    max: number
    min: number
    step: number
}

你也可以用条件类型来做，但我认为联合解决方案效果更好：

export interface IObject<T extends ObjectType> {
    type: T
    parameters: T extends 'checked' ? IParametersCheck: IParametersCounter
}

或者使用映射接口：

export interface IObject<T extends ObjectType> {
    type: T
    parameters: ParameterMap[T]
}
type ParameterMap ={
    'checked': IParametersCheck
    'counter': IParametersCounter
}

export type ObjectType = keyof ParameterMap