【问题标题】:Typescript: how to REQUIRE a property if a type is supplied and FORBID that property if the type is not supplied?打字稿:如果提供了类型,如何要求一个属性,如果没有提供类型,如何禁止该属性?
【发布时间】:2019-11-12 17:21:22
【问题描述】:

我正在从快速 REST api 返回数据。我想让我的 API 与客户端紧密通信。为此,我正在尝试创建一个函数apiJsonResponse,通过该函数,我返回的所有数据都将汇集到服务器上。这是我到目前为止的一个例子:

// Example route 1
router.get('/authorized', (req: Request, res: Response) => {
  return apiJsonResponse<{ foo: string }>(res, 200, {
    message: 'Success',
    data: { foo: 'bar' }
  });
});

// Example route 2
router.get('/unauthorized', (req: Request, res: Response) => {
  return apiJsonResponse(res, 401, {
    message: 'User is not authorized',
    isMessageDisplayable: true
  });
});

// Type-explicit wrapper around `res.status().json()`
function apiJsonResponse<T = undefined>(res: Response, status: number, body: TBody<T>): Response {
  return res.status(status).json(body);
}

// My attempt to type for a 'data-case' and a 'no-data-case'
type TBody<T> = T extends undefined ? IBody : IDataBody<T>;

interface IBody {
  message: string; // Event descriptor
  isMessageDisplayable?: boolean; // Flag whether or not to show user message
}

interface IDataBody<T> extends IBody {
  data: T; // Data payload if query is successful
}

所以,基本上,我正在尝试启用两种类型的数据响应。

案例 1:无数据负载。这主要用于 4xx/5xx 事件,我返回一条消息并指示它是否可以显示给最终用户。

案例 2. 数据负载。主要用于返回数据负载的 2xx 事件。

现在,我想要的是我的函数 apiJsonResponse 到 要求 body 参数包含 T 类型的数据属性,如果使用该类型调用此函数:apiJsonResponse&lt;T&gt;(url,{data: x, ... }) 其中 x 满足T。这样,我的客户端可以从这样的路由中获取并期望 body 包含相同类型的数据属性(因此我的服务器和客户端可以使用相同的接口进行通信)。

相反,如果在没有声明任何类型的情况下调用我的函数,那么 typescript 将禁止在 body 参数中包含数据属性。

我希望上面的代码可以解决问题,但事实并非如此。例如,以下对 apiJsonResponse 函数的调用未提供类型,在正文中包含 data 参数,但不会引发打字稿错误:

apiJsonResponse(res, 200, {
    message: 'Success sending basic test',
    data: { test: 'hello-world' },
    isMessageDisplayable: true
  });

显然,我发现我对打字稿条件的理解不足。我推断,如果不提供类型,函数将采用默认的undefined 值(参见上面的&lt;T = undefined&gt;),并且条件语句T extends undefined ? IBody : IDataBody&lt;T&gt; 将因此在未提供类型时返回IBody。然而,这种情况并非如此;相反,无论是否提供类型,上述代码似乎总是返回 IDataBody。

非常感谢您对这里发生的事情的澄清和/或解决方案!

【问题讨论】:

    标签: typescript


    【解决方案1】:

    好的,我找到了问题和解决方案。原始代码很接近(条件不是问题),但是当您向 apiJsonResponse 函数提供具有具体值的参数时,Typescript 想要推断类型 T,然后基于该推断,它将选择后一个接口(@98​​7654321 @) 在条件中。

    为了防止类型推断,您可以将类型逻辑基于扩展第一个类型变量的第二个类型变量。以下修改为我提供了我正在寻找的确切行为:

    export function apiJsonResponse<T = undefined, U extends T = T>(
      res: Response,
      status: number,
      body: TBody<U>
    ): Response {
      return res.status(status).json(body);
    }
    

    【讨论】:

      猜你喜欢
      • 2019-04-05
      • 1970-01-01
      • 2021-03-08
      • 2020-08-12
      • 1970-01-01
      • 2016-10-12
      • 2023-01-14
      • 1970-01-01
      • 2021-12-16
      相关资源
      最近更新 更多