Question

地图对象（https://developer.mozilla.org/en-US/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？

Answer 1

如果只想记录地图键的含义，则可以使用类型别名：

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

// Outside the class
type FruitName = string;

FruitName仅用于文档；如果您还定义FruitColor = string，则将FruitName和FruitColor混合使用时TypeScript将不会报告错误。如果您要输入错误，可以使用“品牌”字符串类型。一个web search为我提供了一些教程，其中包括this one，它与我在一个项目中使用的最接近。

如何在打字稿中为Map对象正确注释/文档

1 个答案: