如何从打字稿中的类中创建不包括实例方法的类型？

Question

给定一个包含属性和方法的类，我想派生一个只包含其属性的类型。

例如，如果我定义一个类如下：

class MyObject {

  constructor(public prop1: string, public prop2: number) {}

  instanceMethod() { ... }
}

我想要一个类型，比如MyObjectConstructor，它会是这样的：

type MyObjectConstructor = {
  prop1: string;
  prop2: number;
}

我知道我可以使用内置类型Pick 并通过名称手动选择我想要的键，但我不想重复所有键，并且每次添加时都必须更改它们我的班级的新属性。

有没有办法定义一个泛型类型ConstructorType<T>只返回打字稿中类的属性？

Answer 1

感谢这篇文章，我找到了一种方法来排除与给定类型匹配的所有属性：https://medium.com/dailyjs/typescript-create-a-condition-based-subset-types-9d902cea5b8c

我做了一些改编，但这里是细节：

// 1 Transform the type to flag all the undesired keys as 'never'
type FlagExcludedType<Base, Type> = { [Key in keyof Base]: Base[Key] extends Type ? never : Key };
    
// 2 Get the keys that are not flagged as 'never'
type AllowedNames<Base, Type> = FlagExcludedType<Base, Type>[keyof Base];
    
// 3 Use this with a simple Pick to get the right interface, excluding the undesired type
type OmitType<Base, Type> = Pick<Base, AllowedNames<Base, Type>>;
    
// 4 Exclude the Function type to only get properties
type ConstructorType<T> = OmitType<T, Function>;

Try It

可能有更简单的方法，我尝试使用ConstructorParameters 并定义构造函数签名但没有结果。

更新

在此处浏览 typescript 文档时发现了一个等价物： https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types

type NonFunctionPropertyNames<T> = {
  [K in keyof T]: T[K] extends Function ? never : K;
}[keyof T];
type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>;

由于省略的类型不是通用的，所以它有点不那么冗长，但它的想法是一样的。

Answer 2

给定一个包含属性和方法的类，我想派生一个只包含其属性的类型。

从您的示例中，您似乎希望结果仅包含字段 (as opposed to only properties)。这是一种从对象或类实例中挑选出字段的类型。

type DataPropertyNames<T> = {
  [K in keyof T]: T[K] extends Function ? never : K;
}[keyof T];

type DataPropertiesOnly<T> = {
  [P in DataPropertyNames<T>]: T[P] extends object ? DTO<T[P]> : T[P]
};

export type DTO<T> = DataPropertiesOnly<T>;

我使用首字母缩略词DTO 来表示数据传输对象。感谢 l00ser2410656 的this playground demo。

Answer 3

在阅读此issue 时，我发现有人在发布这种简洁的类型

type ExcludeMethods<T> = 
  Pick<T, { [K in keyof T]: T[K] extends (_: any) => any ? never : K }[keyof T]>;

请注意，此类型不会删除 getter 和 setter。

编辑：甚至更短

type ExcludeMethods<T> = 
  Pick<T, { [K in keyof T]: T[K] extends Function ? never : K }[keyof T]>;

Answer 4

export type DTO<T> = {
    [P in {
        [K in keyof T]: undefined extends T[K] ? never : T[K] extends (...args) => any ? never : K;
    }[keyof T]]: T[P] extends object ? DTO<T[P]> : T[P];
} &
    Partial<
        {
            [P in {
                [K in keyof T]: undefined extends T[K] ? K : never;
            }[keyof T]]: T[P] extends object ? DTO<T[P]> : T[P];
        }
    >;

Answer 5

export type Defined<T> = Exclude<T, undefined>;
        
export type NonFunctionPropertyNames<T> = { [K in keyof T]: T[K] extends Function ? never : K }[keyof T];
    
export type PartialModel<T extends Model> = {
  [K in NonFunctionPropertyNames<T>]?: Defined<T[K]>
};