Typescript 接口类型，带有不同类型的可选键和 strictNullChecks

Question

我正在尝试在 typescript 中创建以下界面：

type MoveSpeed = "min" | "road" | "full";

interface Interval {
  min?: number,
  max?: number
}

interface CreepPlan {
  [partName: string] : Interval;
  move?:    MoveSpeed;
}

但是，此语法无效。编译器说Property 'move' of type '"min" | "road" | "full" | undefined' is not assignable to string index type 'Interval'.。

我正在使用编译器选项 strictNullChecks:true，这就是为什么 undefined 隐式包含在 move? 键中。

但是，这个语法是有效的：

type MoveSpeed = "min" | "road" | "full";

interface Interval {
  min?: number,
  max?: number
}

interface CreepPlan {
  [partName: string] : Interval;
  move:    MoveSpeed;            // 'move' is required
}

我想表达“CreepPlan 由 string:Interval 对组成的想法，除了可选的 'move' 键是一个 string:MoveSpeed 对。”可以用打字稿来表达吗？

Answer 1

如打字稿docs 中所述，如果您使用可索引属性，则所有其他属性的所有返回类型都应可分配给索引返回类型的返回类型。 那是因为foo['bar'] 和foo.bar 是一样的。

那么为什么会这样呢？

interface CreepPlan {
    [partName: string]: Interval;
    move: MoveSpeed;
}

因为任何MoveSpeed 都是有效的Interval 值（它是一个未定义min/max 的区间。

为什么这不起作用？

interface CreepPlan {
     [partName: string]: Interval;
     move?: MoveSpeed;
 }

move? 具有类型 MoveSpeed 加上 undefined 类型。如果 is 具有未定义的值，则它不能分配给 Interval，因此编译器会正确显示错误。

你怎么能解决这个问题？只需让索引器将undefined 作为有效值：

interface CreepPlan {
    [partName: string]: Interval | undefined;
    move?: MoveSpeed;
}

Answer 2

您在写的时候声明CreepPlan 上的所有属性都有Interval-type 值：

interface CreepPlan {
  [partName: string] : Interval;
}

即，CreepPlan 的所有字符串索引可访问属性都将是 Interval。这也适用于move，因为foo['move'] 与foo.move 相同。

然而，看看Interval，它没有必要的结构：

interface Interval {
  min?: number,
  max?: number
}

该合同中没有必填字段，但它确实需要一个对象。它会很乐意接受一个空对象，但它需要一些可以具有min和max属性的对象。

另一方面，您的MoveSpeed 类型允许undefined：

属性“移动”类型为“最小”| “路” | “满” | undefined' 不能分配给字符串索引类型 'Interval'。

因此，Interval 必须是一个没有必需属性的对象（string 可以轻松满足）但不允许 undefined，而 MoveSpeed确实允许。

你的类型是不相交的，但直到你解决它们一两次才明显。