javascript - 如何在 TypeScript 中为 Map 对象正确添加注释/文档

Map 对象 (https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Map)

例如,

private _fruit: Map<string, FruitDetail> = new Map();

它通常附带如下方法：

public setFruit(fruitName: string, fruitDetail: FruitDetail) {...}

public getFruit(fruitName: string): FruitDetail {...}

但是属性中只声明了 string 类型，我该如何让其他人知道它应该是 fruitName 而不是 fruitColor？

答案＃1

如果你只是想记录映射键的含义，你可以使用类型别名：

private _fruit: Map<FruitName, FruitDetail> = new Map();

// Outside the class
type FruitName = string;

FruitName 仅用于文档；如果你还定义了 FruitColor=string，当你混用 FruitName 和 FruitColor 时，TypeScript 不会报错。如果你想要报错，可以使用“带品牌”的字符串类型。通过网络搜索，我找到了一些教程，其中这个教程最接近我在一个项目中使用的方法。