TypeScript：如何创建一个类型或接口，它是一个具有 n 个键之一的对象还是一个字符串？

Question

我需要创建一个接口，该接口可以是字符串，也可以是具有三个键之一的对象。

基本上我有一个函数，根据错误返回一些东西：

export const determineError = (error: ServerAlerts): AlertError => {
  if (typeof error !== "string") {
    if (error.hasOwnProperty("non_field_errors")) {
      return error.non_field_errors[0];
    } else if (error.hasOwnProperty("detail")) {
      return error.detail;
    } else if (error.hasOwnProperty("email")) {
      return error.email[0];
    } else {
      return UNKNOWN_ERROR;
    }
  } else {
    return error;
  }
};

以下是类型：

export type AlertError =
  | "Unable to log in with provided credentials."
  | "E-mail is not verified."
  | "Password reset e-mail has been sent."
  | "Verification e-mail sent."
  | "A user is already registered with this e-mail address."
  | "Facebook Log In is cancelled."
  | string;

export interface ServerAlerts {
  non_field_errors: [string];
  detail: string;
  email: [string];
}

但是我在这里设计ServerAlerts 的方式对我不起作用，因为ServerAlerts 也可以是string，如果它有一个键，它就只有一个。

你会如何设计这样的类型或接口？

编辑：我尝试通过给它们一个问号来使键成为可选，但随后我的 linter 在 determineError 中的相应键的错误返回语句中抱怨。

Answer 1

如果我的理解正确，只需将参数声明为ServerAlerts 或string：

export const determineError = (error: ServerAlerts|string): AlertError => {
// -----------------------------------------------^^^^^^^

在评论中你说过所有三个ServerAlerts 属性都是可选的，所以你需要用? 标记它们：

interface ServerAlerts {
  non_field_errors?: [string];
  detail?: string;
  email?: [string];
}

但是，这意味着任何输入 object 的内容也可以使用，因为所有字段都是可选的。所以如果你同时做这两件事，你会得到：

determineError("foo");                       // Works
determineError({ non_field_errors: ["x"] }); // Works
determineError({ detail: "x" });             // Works
determineError({ email: ["x"] });            // Works
determineError({});                          // Works (because all fields are optional)
let nonLiteralServerAlerts: object;
nonLiteralServerAlerts = { foo: ["x"] };
determineError(nonLiteralServerAlerts);      // Works (because all fields are optional)
determineError({ foo: ["x"] });              // Fails (correctly)

Playground example

这表明您可以只在参数签名中使用object。如果您想需要三个字段之一（我相信这会取消 UNKNOWN_ERROR 分支），您将定义三个接口并使 ServerAlerts 成为它们的联合：

interface ServerAlertsNonFieldErrors {
  non_field_errors: [string];
}

interface ServerAlertsDetail {
  detail: string;
}

interface ServerAlertsEmail {
  email: [string];
}

type ServerAlerts = ServerAlertsNonFieldErrors | ServerAlertsDetail | ServerAlertsEmail;

然后你会在返回特定字段时使用类型断言：

if (error.hasOwnProperty("non_field_errors")) {
  return (error as ServerAlertsNonFieldErrors).non_field_errors[0];
// ------------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

如果你这样做，那么你会得到：

determineError("foo");                       // Works
determineError({ non_field_errors: ["x"] }); // Works
determineError({ detail: "x" });             // Works
determineError({ email: ["x"] });            // Works
determineError({});                          // Fails (correctly)
let nonLiteralServerAlerts: object;
nonLiteralServerAlerts = { foo: ["x"] };
determineError(nonLiteralServerAlerts);      // Fails (correctly)
determineError({ foo: ["x"] });              // Fails (correctly)

Playground Example