Typescript 如何从对象或类动态生成类型

发布于12月06日

我有如下TS对象:

const myObject = {
   AdminInviteStudent:  ['inviterGivenName', 'inviterFamilyName', 'link'],
   DeleteMappingStudent: ['teacherGivenNameAndInitialOfFamilyName', 'studentGivenName', 'noteLink']
};

基于该对象导出类型的TS函数是什么？

我想将该对象作为参数传递，如下所示:

export type EmailTemplateParameters = getType(myObject);

所有数组值都应设置为必需的字符串.

在这种情况下，EmailTemplateParameters结果应为:

{
  AdminInviteStudent: {
    inviterGivenName: string;
    inviterFamilyName: string;
    link: string;
  };
  DeleteMappingStudent: {
    teacherGivenNameAndInitialOfFamilyName: string;
    studentGivenName: string;
    noteLink: string;
  };
}

或者也许有更好的方法来加强对我最初问题的回答:How to export TypeScript types as object to expose which keys are available

推荐答案

第一步是用as const注释myObject，这样字符串值将被"保留"为文字类型.

const myObject = {
   AdminInviteStudent:  ['inviterGivenName', 'inviterFamilyName', 'link'],
   DeleteMappingStudent: ['teacherGivenNameAndInitialOfFamilyName', 'studentGivenName', 'noteLink']
} as const;

然后，如果我们有一个类型要映射到一个对象上，而数组要创建一个新类型:

type GetType<T extends Record<string, readonly string[]>> = { // allow readonly arrays
  -readonly [K in keyof T]: { // remove readonly modifier
    [P in T[K][number]]: string;
  }
};

我们可以将类型(typeof)myObject传递给它，并得到正确的结果:

export type EmailTemplateParameters = GetType<typeof myObject>;

Playground个

解决前面的问题，你应该从对象中派生类型，而不是从类型中派生对象(这是不可能的):

type CreateType<Keys extends readonly string[]> = { [K in Keys[number]]: string };

type AdminInviteStudent = CreateType<typeof myObject["AdminInviteStudent"]>;