我想编写一个非常聪明的DataTable类
export interface ColumnDefinition<?> {
readonly name: ?;
title: string;
align?: 'left' | 'center' | 'right';
sortable?: boolean;
hideable?: boolean;
// ...
}
export interface DataTableOptions<?> {
readonly columnDefinitions: ColumnDefinition<?>[];
// ...
}
export class DataTable<?> {
private readonly columnDefinitions: ReadonlyArray<ColumnDefinition>;
constructor(options: DataTableOptions<?>) {
this.columnDefinitions = options.columnDefinitions;
// ...
}
// ...
public title(columnName: ?): string {
return this.columnDefinitions.find(({ name }) => name === columnName)?.title ?? '';
}
// ...
}
我在不知道如何提供通用类型的地方放了?
目标是拨打以下电话
const table = new DataTable({
columnDefinitions: [
{ name: 'id', title: 'ID' },
{ name: 'v1', title: 'Value 1' },
{ name: 'v2', title: 'Value 2' }
],
// ...
});
然后,表格的键入应如下:DataTable<'id' | 'v1' | 'v2'>
如果有人尝试使用相同名称的多个列定义,则会发生错误
此外,某些成员函数应该从中受益
table.title('id'); // 'ID'
table.title('test'); // compile time error
答案 0 :(得分:2)
可以轻松地确保我们捕获传入的实际名称。我们将以元组类型捕获整个列定义(这在尝试测试唯一性时也将提供帮助)
要将columnDefinitions
的类型捕获为元组类型,我们需要一个type参数,将其命名为C
,约束为[ColumnDefinition] | ColumnDefinition[]
。第一个[ColumnDefinition]
确保我们获得元组类型,而ColumnDefinition[]
确保我们允许任何类型的元组。
要捕获每个属性的名称,我们需要做更多的事情。首先,ColumnDefinition
需要扩展string
(interface ColumnDefinition<N extends string>{...}
)的类型参数。这将使我们能够编写类似ColumnDefinition<'id'>
可以在ColumnDefinition
中保留名称的字符串文字类型,我们需要回到C
的约束。现在,我们需要在约束中指定一个类型参数。[ColumnDefinition<string>] | ColumnDefinition<string>[]
是有效的,但不会捕获字符串文字类型,它只会为元组中的所有项目推断string
。要获取字符串文字类型,我们需要将一个额外的类型参数限制为string
(这将触发编译器保留字符串文字类型。
所以DataTable
的最终定义是class DataTable<C extends [ColumnDefinition<V>] | ColumnDefinition<V>[], V extends string> {... }
使用C
类型,我们可以相对于title
将参数键入C
。所以我们可以写title(columnName: C[number]['name']): string
唯一性部分难以保证。我们将需要一个递归的条件类型(附加了各种警告)。但这是可以完成的。如果没有重复项或包含自定义错误消息的元组(在调用构造函数时会导致错误),则在IsUnique
下面的类型将返回{}
。
产生的解决方案:
export interface ColumnDefinition<N extends string> {
readonly name: N;
title: string;
align?: 'left' | 'center' | 'right';
sortable?: boolean;
hideable?: boolean;
// ...
}
export interface DataTableOptions<C extends ColumnDefinition<string>[]> {
readonly columnDefinitions: C;
// ...
}
type ColumnName<T> = T extends ColumnDefinition<infer N> ? N : never;
type IsUnique<T extends any[], E = never> = {
next: ((...a: T) => void) extends ((h: infer H, ...t: infer R) => void) ?
[ColumnName<H>] extends [E] ? ["Names are not unique", ColumnName<H>, "was found twice"] :
IsUnique<R, E | ColumnName<H>>: ["NO", T]
stop: {}
}[T extends [] ? "stop" : "next"];
export class DataTable<C extends [ColumnDefinition<V>] | ColumnDefinition<V>[], V extends string> {
private readonly columnDefinitions: Readonly<C>;
constructor(options: DataTableOptions<C> & IsUnique<C> ) {
this.columnDefinitions = options.columnDefinitions;
// ...
}
public title(columnName: C[number]['name']): string {
return this.columnDefinitions.find(({ name }) => name === columnName)?.title ?? '';
}
// ...
}
const table = new DataTable({
columnDefinitions: [
{ name: 'id', title: 'ID' },
{ name: 'v1', title: 'Value 1', align: "right" },
{ name: 'v2', title: 'Value 2', align: "right" }
// { name: 'id', title: 'ID' },
// Comment the line above to get the error below
// Type '{ columnDefinitions: [{ name: "id"; title: string; }, { name: "v1"; title: string; }, { name: "v2"; title: string; }, { name: "id"; title: string; }]; }' is not assignable to type '["Names are not unique", "id", "was found twice"]'.(2345)
],
// ...
});
table.title("Id") // err
table.title("id") // ok
答案 1 :(得分:1)
我相信您正在寻找type variable generics!对泛型类型变量进行操作的类的简单示例为:
interface Data<T> {
val: T;
}
class DataTable<T> {
private data: Data<T>;
constructor(val: T) {
this.data = {
val,
}
}
}
您已经更新了您的问题,但我不确定100%到底在做什么,但是我认为您想使用类型别名,并使用如下类型的变量进行扩展:
type Id = "id";
type IdObject = {
id: Id,
title: string
}
type V1 = "v1";
type V1Object = {
name: V1;
title: string;
}
type EitherOne = V1Object | IdObject;
interface Data<T extends EitherOne> {
val: T;
}
class DataTable<T> {
private data: Data<T>;
constructor(val: T) {
this.data = {
val,
}
}
}