Typescript 中的对象索引键类型

Question

我将泛型类型定义为

interface IDictionary<TValue> {
    [key: string|number]: TValue;
}

但是 TSLint 正在抱怨。 我应该如何定义一个可以作为键的对象索引类型？ 我也试过这些，但没有运气。

interface IDictionary<TKey, TValue> {
    [key: TKey]: TValue;
}

interface IDictionary<TKey extends string|number, TValue> {
    [key: TKey]: TValue;
}

type IndexKey = string | number;

interface IDictionary<TValue> {
    [key: IndexKey]: TValue;
}

interface IDictionary<TKey extends IndexKey, TValue> {
    [key: TKey]: TValue;
}

以上都不起作用。

那怎么办呢？

Answer 1

您可以通过使用IDictionary<TValue> { [key: string]: TValue }来实现这一点，因为数值将自动转换为字符串。

下面是一个使用示例：

interface IDictionary<TValue> {
    [id: string]: TValue;
}

class Test {
    private dictionary: IDictionary<string>;

    constructor() {
       this.dictionary = {}
       this.dictionary[9] = "numeric-index";
       this.dictionary["10"] = "string-index"

       console.log(this.dictionary["9"], this.dictionary[10]);
    }
}
// result => "numeric-index string-index"

如您所见，字符串索引和数字索引是可以互换的。

Answer 2

在 javascript 中，对象的键只能是字符串（在es6符号中也是如此）。
如果你传递一个数字，它会被转换成一个字符串：

let o = {};
o[3] = "three";
console.log(Object.keys(o)); // ["3"]

正如你所看到的，你总是得到{ [key: string]: TValue; } { [key: string]: TValue; } .

打字稿让您可以像这样定义一个以number为键的地图：

type Dict = { [key: number]: string };

并且编译器会检查在赋值时你总是传递一个数字作为键，但在运行时对象中的键将是字符串。

所以你可以有{ [key: number]: string }或{ [key: string]: string }但不是string | number的联合string | number string | number原因如下：

let d = {} as IDictionary<string>;
d[3] = "1st three";
d["3"] = "2nd three";

您可能希望d在这里有两个不同的条目，但实际上只有一个。

您可以做的是使用Map ：

let m = new Map<number|string, string>();
m.set(3, "1st three");
m.set("3", "2nd three");

在这里，您将有两个不同的条目。

Answer 3

尽管对象键总是底层的字符串，并且键入索引器作为字符串覆盖数字，但有时您希望函数知道传递给它的对象的键。 考虑这个映射函数，它像Array.map一样Array.map但带有对象：

function map<T>(obj: Object, callback: (key: string, value: any) => T): T[] {
    // ...
}

key被限制为string ，而 value 是完全无类型的。 10 次中可能有 9 次没问题，但我们可以做得更好。 假设我们想做这样的蠢事：

const obj: {[key: number]: string} = { 1: "hello", 2: "world", 3: "foo", 4: "bar" };
map(obj, (key, value) => `${key / 2} ${value}`);
// error: The left-hand side of an arithmetic operation must be of type 'any', 'number' or an enum type.

我们不能在不先将键转换为数字的情况下对键执行任何算术运算（请记住： "3" / 2在 JS 中有效并解析为number ）。 我们可以通过在 map 函数上输入一些技巧来解决这个问题：

function map<S, T>(obj: S, callback: (key: keyof S, value: S[keyof S]) => T): T[] {
    return Object.keys(obj).map(key => callback(key as any, (obj as any)[key]));
}

在这里，我们使用泛型S来键入我们的对象，并直接从中查找键和值类型。 如果您的对象是使用通用索引器和值键入的，则keyof S和S[keyof S]将解析为常量类型。 如果传入具有keyof S属性的对象， keyof S将被限制为属性名称，而S[keyof S]将被限制为属性值类型。