Question

是否可以使用Typescript的条件类型检查接口是否具有必填字段？

type AllRequired = { a: string; b: string }
type PartiallyRequired = { a: string; b?: string }
type Optional = { a?: string; b?: string }

// Is it possible to change this, so the below works
type HasRequiredField<T> = T extends {} ? true : false

type A = HasRequiredField<AllRequired> // true
type B = HasRequiredField<PartiallyRequired> // true
type C = HasRequiredField<Optional> // false

Answer 1

是的，you can detect if properties are optional。它有点iffy with index signatures，但是您的类型没有它们，因此我不会担心它们。

在这里，您可以仅提取对象类型的非可选属性的键

type RequiredKeys<T> = { [K in keyof T]-?:
  ({} extends { [P in K]: T[K] } ? never : K)
}[keyof T]

然后您可以检查它是否包含其中的任何一个（如果RequiredKeys<T>是never则没有）：

type HasRequiredField<T> = RequiredKeys<T> extends never ? false : true

这将提供您想要的结果：

type A = HasRequiredField<AllRequired> // true
type B = HasRequiredField<PartiallyRequired> // true
type C = HasRequiredField<Optional> // false

希望有所帮助；祝你好运！

Answer 2

找到了另一种更简单的方法，至少适用于 TS 3.8.3。

// if Partial<T> extends T none of the fields are required.
type HasRequiredFeilds<T> = Partial<T> extends T ? false : true

用例示例

type Info<TInfo> = Partial<TInfo> extends TInfo
   ? { info?: TInfo }
   : { info: TInfo };

type A = { type: 'A' } & Info<{ abc?: string }>
type B = { type: 'B' } & Info<{ abc: string }>

// Valid
let a1: A = { type: 'A' };
// Valid
let a2: A = { type: 'A', info: {} };
// Valid
let a3: A = { type: 'A', info: { abc: 'hello' } };
// Invalid
let a4: A = { type: 'A', info: { abc: 3 } };

// Invalid
let b1: B = { type: 'B' }
// Invalid
let b2: B = { type: 'B', info: {} };
// Valid
let b3: B = { type: 'B', info: { abc: 'Hello' } };
// Invalid
let b4: B = { type: 'B', info: { abc: 5 } };

检查接口是否具有必填字段

2 个答案: