我正在为第三方js库创建一个TypeScript定义文件。其中一个方法允许使用options对象,而options对象的一个属性接受列表中的字符串:"collapse"、"expand"、"end-expand"和"none"。
我有一个接口的选项对象:
interface IOptions {
indent_size?: number;
indent_char?: string;
brace_style?: // "collapse" | "expand" | "end-expand" | "none"
}
接口是否可以强制执行这一点,因此如果您包含带有brace_style属性的IOptions对象,它将只允许可接受列表中的字符串?
也许不是你想要的,但enum似乎是一个完美的解决方案。
enum BraceStyle {Collapse, Expand, EndExpand, None}
interface IOptions {
indent_size?: number;
indent_char?: string;
brace_style?: BraceStyle
}
然而,枚举是基于数字的。这意味着在运行时一个实值,例如BraceStyle。这里崩溃值为0。但是您可以将它们用于其他脚本,甚至是非typescript脚本,因为它们被编译为对象。这是BraceStyle在compile&run之后的样子:
{
0: "Collapse",
1: "Expand",
2: "EndExpand",
3: "None",
Collapse: 0,
Expand: 1,
EndExpand: 2,
None: 3
}
如果需要字符串,可以使用带有静态成员的类,如下所述