具有不同类型的getter和setter的索引签名

基础概念

索引签名（Index Signature）是TypeScript中的一个特性，用于描述对象中键的类型以及对应的值的类型。它允许你在类型定义中表示一个对象，其键可以是某种特定类型的任意值，而值则具有另一种特定的类型。

不同类型的getter和setter

在TypeScript中，你可以为索引签名定义getter和setter方法，这些方法可以有不同的访问修饰符（如public、private、protected）和返回类型。这为对象的键值对提供了更细粒度的控制。

示例代码

class Example {
    private _data: { [key: string]: number } = {};

    // Getter for index signature
    public get(key: string): number {
        return this._data[key];
    }

    // Setter for index signature with a different type for the value
    public set(key: string, value: number): void {
        this._data[key] = value;
    }

    // Another setter with a different access modifier and return type
    protected setAnother(key: string, value: number): boolean {
        if (value >= 0) {
            this._data[key] = value;
            return true;
        }
        return false;
    }
}

const example = new Example();
example.set("age", 30);
console.log(example.get("age")); // Output: 30

优势

类型安全：索引签名提供了编译时的类型检查，减少了运行时错误。
灵活性：允许对象具有动态的键，同时保持类型的一致性。
代码可读性：通过getter和setter方法，可以清晰地表达对对象属性的访问和修改逻辑。

类型

字符串索引签名：{ [key: string]: ValueType }
数字索引签名：{ [key: number]: ValueType }

应用场景

动态属性对象：当对象的属性数量和名称在编译时未知时。
数据缓存：使用索引签名来存储键值对数据。
配置管理：管理具有动态键的配置项。

遇到的问题及解决方法

问题：在使用索引签名时，可能会遇到类型不匹配的问题，尤其是在getter和setter方法中。

原因：可能是由于在getter或setter中使用了错误的类型，或者在设置值时没有进行适当的类型检查。

解决方法：

类型检查：在setter方法中添加类型断言或类型检查，确保传入的值符合预期类型。
默认值：为getter方法提供默认值，以防止访问不存在的键时返回undefined。

class SafeExample {
    private _data: { [key: string]: number } = {};

    public get(key: string): number {
        return this._data[key] ?? 0; // 提供默认值0
    }

    public set(key: string, value: number): void {
        if (typeof value === "number") {
            this._data[key] = value;
        } else {
            throw new Error("Value must be a number");
        }
    }
}

通过这种方式，可以确保在使用索引签名时，对象的键值对始终保持类型安全和一致性。