将 Typescript 接口中的所有属性设为可选

发布于10月17日

我的应用程序中有一个接口:

interface Asset {
  id: string;
  internal_id: string;
  usage: number;
}

这是post界面的一部分:

interface Post {
  asset: Asset;
}

我还有一个用于后期草稿的接口，其中assets资源对象可能只被部分构造

interface PostDraft {
  asset: Asset;
}

我想允许一个PostDraft对象拥有一个部分assets资源对象，同时仍然判断那里的属性的类型(所以我不想只是将其与any交换).

我基本上想要一种能够生成以下内容的方法:

interface AssetDraft {
  id?: string;
  internal_id?: string;
  usage?: number;
}

没有完全重新定义Asset接口.有办法做到这一点吗？如果不是，在这种情况下，安排我的类型的明智方式是什么？

推荐答案

这在TypeScript中是不可能的<；2.1不创建具有可选属性的附加接口；但是，这可以通过在TypeScript 2.1+中使用映射类型来实现.

为此，请使用TypeScript默认提供的Partial<T>类型.

interface PostDraft {
    asset: Partial<Asset>;
}

现在，asset上的所有属性都是可选的，这将允许您执行以下操作:

const postDraft: PostDraft = {
    asset: {
        id: "some-id"
    }
};

About 100

Partial<T>是defined，作为一个映射类型，使得所提供类型中的每个属性都是可选的(使用?标记).

type Partial<T> = {
    [P in keyof T]?: T[P];
};

阅读有关映射类型here和in the handbook的更多信息.

Deep Partial

如果您想要在对象上递归工作的部分实现，那么可以在TS 4.1+中使用以下类型:

type DeepPartial<T> = {
    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
};

实用课程推荐