我在Lovefield中有很多表,以及它们各自的接口,说明它们有哪些列。
例子:
export interface IMyTable {
id: number;
title: string;
createdAt: Date;
isDeleted: boolean;
}
我想有这个接口的属性名在这样的数组中:
const IMyTable = ["id", "title", "createdAt", "isDeleted"];
我不能直接基于接口IMyTable创建一个对象/数组,因为我将动态地获得表的接口名称。因此,我需要在接口中迭代这些属性,并从中获得一个数组。
我如何实现这个结果?
从TypeScript 2.3(或者我应该说2.4,因为在2.3这个特性包含一个bug,该bug已在typescript@2.4-dev中修复)开始,你可以创建一个自定义转换器来实现你想要做的事情。
实际上,我已经创建了这样一个自定义转换器,它支持以下功能。
https://github.com/kimamula/ts-transformer-keys
import { keys } from 'ts-transformer-keys';
interface Props {
id: string;
name: string;
age: number;
}
const keysOfProps = keys<Props>();
console.log(keysOfProps); // ['id', 'name', 'age']
不幸的是,定制变压器目前还不太容易使用。你必须将它们与TypeScript转换API一起使用,而不是执行tsc命令。有一个问题,要求插件支持自定义变压器。
如果您不能使用自定义转换器(或不愿意使用),我认为最好的方法就是我将要展示的方法,它具有以下优点:
它允许“半自动”填充数组(至少在VS Code中);
它会生成一个数组,TypeScript会将其识别为包含接口键的并集元素;
它不涉及降低性能的递归技巧。
方法如下:
interface Foo {
fizz?: string;
buzz: number;
}
const FooKeysEnum: { [K in keyof Required<Foo>]: K } = {
fizz: 'fizz',
buzz: 'buzz',
};
const FooKeys = Object.values(FooKeysEnum);
VS Code中“半自动”填充数组的原因是,当FooKeysEnum因为缺少属性而出现红色下划线时,你可以将鼠标悬停在它上面,从“快速修复”菜单中选择“添加缺少属性”。(这个好处已经在这篇文章中展示过了,但我认为还没有人提到过。埃塔:我弄错了;自动补全已经在线程的其他地方提到了。)
最后,通过使用Object.values()而不是Object.keys()来创建数组,你可以让TypeScript识别出FooKeys的类型是("fizz" | "buzz")[]。它不知道FooKeys[0]是“fizz”,FooKeys[1]是“buzz”,但仍然比你用Object.keys()得到的字符串[]要好。
编辑:
在VS Code中,你也可以在键盘绑定中设置快捷键。json用于执行“Quick Fix”,这使得它可以更快地触发添加缺失的属性。看起来是这样的:
{
"key": "shift+cmd+a",
"command": "editor.action.codeAction",
"args": {
"kind": "quickfix",
"apply": "ifSingle"
}
}
然后,如果某个东西有红色下划线,你可以单击它并使用键盘快捷键,如果只有一个可用的快速修复选项,那么它将运行。如果有一种方法可以针对特定的快速修复,那就太好了,如果它可以在文件保存时自动完成,那就更好了,但我认为在撰写本文时这是不可能的。
有些人建议这样做,这是最简单的解决方案:
const properties: (keyof IMyTable)[] = ["id", "title", "createdAt", "isDeleted"];
然而,尽管这增加了一些类型安全性(我们不能错误地使用不存在的属性),但这并不是一个完全安全的解决方案,因为我们可能会错过一些属性并拥有重复的属性。所以我已经修复了这个问题,这个详细的解决方案是完全类型安全的,并防止了数组的编译时类型和运行时值之间的不一致:
const properties: [
keyof Pick<IMyTable, 'id'>,
keyof Pick<IMyTable, 'title'>,
keyof Pick<IMyTable, 'createdAt'>,
keyof Pick<IMyTable, 'isDeleted'>
] = ['id', 'title', 'createdAt', 'isDeleted'];
当然,这只适用于如果你不避免重复,但至少你只需要确保你正确地写所有属性一次(在Pick类型util),如果有任何错误,其余的将总是引发一个错误。我认为这是最健壮的解决方案中简单,容易理解和易读的解决方案。
问题是类型在运行时不可用。我最终定义了一个对象,并从该对象派生了类型。您仍然可以获得类型支持,并获得从单个位置获得所有键的列表的能力。
const myTable = {
id: 0,
title: '',
createdAt: null as Date,
isDeleted: false,
};
export type TableType = typeof myTable;
export type TableTypeKeys = (keyof TableType)[];
export const tableKeys: TableTypeKeys = Object.keys(
myTable
) as TableTypeKeys;
由上面产生的隐式类型将是(你可以用VSCode或其他高质量IDE检查):
type TableType = {
id: number;
title: string;
createdAt: Date;
isDeleted: boolean;
}
type TableTypeKeys = ("id" | "title" | "createdAt" | "isDeleted")[]
在运行时,你将能够访问tableKeys数组
console.log(tableKeys);
// output: ["id" , "title" , "createdAt" , "isDeleted"]