文字稿:过滤keyof类型参数

时间:2020-04-29 16:31:45

标签: typescript

我正在使用打字稿3.8.3,尝试动态查找某种类型的键,并使用它们生成另一个对象。

我有一个Detail对象,并且想仅基于类型Column的属性使用它来动态生成一个Desc对象。 这是我想要做什么的简化代码:

// Model
interface Desc {
    creationDate: Date;
}

interface Address extends Desc {
    zipCode: number;
    adressName: string;
}

interface Order extends Desc {
    id: number;
    orderName: string;
}

interface Detail {
    name: string;
    address: Address[];
    orders: Order[];
}
// Table column configuration
interface Column<T> {
    field: keyof T;
    active: boolean;
}

type ColumnConfig<T> = { [P in keyof T]: Column<T[P] extends Desc ? P : never>[] };

const config: ColumnConfig<Detail> = {
    address: [
        {
            field: "zipCode",
            active: true 
        }, 
        {
            field: "addressName",
            active: true
        }
    ],
    order: [
        {
            field: "id",
            active:false
        },
        {
            field: "orderName",
            active: false
        }
    ],
    // Detail.name should not be available but it is

}

我如何从编译器的帮助下受益来构造我的config对象,从而如果我的Detail对象发生更改,能够检测到任何错误?

谢谢!

1 个答案:

答案 0 :(得分:1)

为了排除映射类型的某些列,我们需要使用中间帮助程序类型,允许我们根据条件T[K] extends Desc仅选择

type ConfigurableColumnsKeys<T extends object> = {
  [K in keyof T]: T[K] extends Desc ? K : never
}[keyof T];

鉴于此,ColumnConfig只需要映射此通用类型,而不是原始的keyof T

type ColumnConfig<T extends object> = {
  [P in ConfigurableColumnsKeys<T>]: Column<P>[] 
};

然后您的配置对象将被正确验证:

  // Error
  name: [
    { field: 'abc', active: true }
  ]

如果您还需要允许 arrays (即Address[]而不是Address),则可以更改帮助程序类型,检查T extends Desc[]。此外,您还需要一个UnboxArray助手,以为列配置提取项值Order[]-> Order

type ConfigurableColumnsKeys<T extends object> = {
  [K in keyof T]: T[K] extends Desc ? K : T[K] extends Desc[] ? K : never
}[keyof T];

type UnboxArray<T> = T extends Array<infer V> ? V : T;

type ColumnConfig<T extends object> = {
  [P in ConfigurableColumnsKeys<T>]: Column<UnboxArray<T[P]>>[]
};

您可以在以下操场上看到它:Playground Link