typescript - 计算值可索引的对象中键名的联合类型

Question

我想编写一个 indexByProp 函数，它将索引 Prop 的选择限制为可索引值(字符串、数字、符号)。

本期是 https://github.com/microsoft/TypeScript/issues/33521 的延续。到目前为止，我尝试构建此功能可以在 TS Playground link 中找到。 .

我期望的期望结果是，例如:

indexByProp('bar', [{ // should be ok
  bar: 1, 
  foo: '2', 
  qux: () => {}
}])

indexByProp('qux', [{ // should be type error
  bar: 1, 
  foo: '2', 
  qux: () => {}
}])

Answer 1

您正在寻找这样的东西:

type KeysMatching<T, V> = NonNullable<
  { [K in keyof T]: T[K] extends V ? K : never }[keyof T]
>;

哪里KeysMatching<T, V>给你 T 的 key 其属性可分配给 V 。它looks up mapped 的属性值, conditional键入以执行此操作。展示其工作原理的示例:

interface Foo {
  a?: string;
  b: number;
}

// give me all the keys of Foo whose properties are assignable to 
// string | undefined... expect to get "a" back
type Example = KeysMatching<Foo, string | undefined>;

评估如下:

type Example2 = NonNullable<
  {
    a?: Foo["a"] extends string | undefined ? "a" : never;
    b: Foo["b"] extends string | undefined ? "b" : never;
  }["a" | "b"]
>;

type Example3 = NonNullable<
  {
    a?: string | undefined extends string | undefined ? "a" : never;
    b: number extends string ? "b" : never;
  }["a" | "b"]
>;

type Example4 = NonNullable<{ a?: "a"; b: never }["a" | "b"]>;

type Example5 = NonNullable<"a" | undefined | never>;

type Example6 = NonNullable<"a" | undefined>;

type Example7 = "a";

这给出了"a"正如预期的那样。

---

然后，IndexableKeys只是:

type IndexableKeys<T> = KeysMatching<T, keyof any>;

还有你的indexByProp()函数看起来像:

const indexByProp = <X extends Indexable>(
  propName: IndexableKeys<X>,
  xs: X[]
): Indexable<X> => {
  const seed: Indexable<X> = {};
  return xs.reduce((index, x) => {
    const address = x[propName];
    index[address as keyof typeof index] = x; // need assertion
    return index;
  }, seed);
};

您的测试行为符合预期:

indexByProp("bar", [
  {
    bar: 1,
    foo: "2",
    qux: () => {}
  }
]); // okay

indexByProp("qux", [
  //        ~~~~~  error!
  // Argument of type '"qux"' is not assignable to parameter of type '"bar" | "foo"'.
  {
    // should be type error
    bar: 1,
    foo: "2",
    qux: () => {}
  }
]);

希望有帮助；祝你好运!

Link to code