如何将值限制为对象的键？

Question

假设我有以下内容：

export const ContentType = {
    Json: "application/json",
    Urlencoded: "application/x-www-form-urlencoded",
    Multipart: "multipart/form-data",
};

export interface RequestOptions {
    contentType: string,
}

const defaultOptions: Partial<RequestOptions> = {
    contentType: ContentType.Json,
};

我将如何限制 contentType 以便只使用在 ContentType 中声明的键？

Answer 1

您可以使用string literal types。不要将contentType 输入为string，而是将其输入为可能值的文字类型。

export interface RequestOptions {
    contentType: "application/json" | "multipart/form-data" | "multipart/form-data:"
}

为避免重复您的常量，您可以单独声明它们并将contentType 键入为typeof ConstantString：

export const ContentTypeJson = "application/json";
export const ContentTypeUrlencoded = "application/x-www-form-urlencoded";
export const ContentTypeMultipart = "multipart/form-data";


export interface RequestOptions {
    contentType: typeof ContentTypeJson| typeof ContentTypeUrlencoded | typeof ContentTypeMultipart,
}

const defaultOptions: Partial<RequestOptions> = {
    contentType: ContentTypeJson,
};

Answer 2

这是我从 TypeScript 2.1 开始的首选方式：

export const contentTypes = {
    "application/json": true,
    "application/x-www-form-urlencoded": true,
    "multipart/form-data": true
};

type ContentType = keyof typeof contentTypes;

export interface RequestOptions {
    contentType: ContentType;
}

const defaultOptions: Partial<RequestOptions> = {
    contentType: "application/json",
};

Try it in TypeScript Playground

• 在对象字面量中定义一组有效字符串。
• 使用keyof 创建一个包含该对象键的类型。它是一个字符串联合类型。
• 将您的字符串属性键入该联合类型，编译器将只允许这些字符串。