Node.js + Express + TypeScript:req.query 类型

在使用 Node 和 Express.js 时,可能存在需要访问req.query的情况,这是一个包含路由中每个查询字符串参数的属性的对象。例如,给定这样的路线:

http://localhost:3000?foo=abc&bar=def&something=123

然后req.query将如下所示:

{ foo: 'abc', bar: 'def', something: '123' }

如果您使用TypeScript编写代码,您可能想知道req.query  正确类型是什么?这个问题有不止一个解决方案。****

解决方案 1

Request接口(可以从express导入)是一个接受附加定义的泛型:

interface Request<
        P = core.ParamsDictionary,
        ResBody = any,
        ReqBody = any,
        ReqQuery = core.Query,
        Locals extends Record<string, any> = Record<string, any>
    > extends core.Request<P, ResBody, ReqBody, ReqQuery, Locals> {}

因此,我们可以这样做:

import { Request, Response, NextFunction } from 'express';

// interfaces
interface ReqParams {
  /* Add something as needed */
}
interface ReqBody {
  /* Add something as needed */
}
interface Resbody {
  /* Add something as needed */
}
interface ReqQuery {
  foo: string;
  bar: string;
  something?: string;
}

// controller
export const getThings = (
  req: Request<ReqParams, ReqBody, Resbody, ReqQuery>,
  res: Response,
  next: NextFunction
) => {
  const { foo, bar, something } = req.query;
  console.log(foo, bar, something);

  res.status(200).json({ message: 'Welcome to KindaCode.com!' });
};

解决方案 2

您还可以像这样使用类型转换:

import { Request, Response, NextFunction } from 'express';

// controller
export const getThings = (req: Request, res: Response, next: NextFunction) => {

  const foo: string = req.query.foo as string;
  const bar:string = req.query.bar as string;
  const something: string = req.query.something as string;
  console.log(foo, bar, something);

  res.status(200).json({ message: 'Welcome to KindaCode.com!' });
};
免责声明:
1.本站所有内容由本站原创、网络转载、消息撰写、网友投稿等几部分组成。
2.本站原创文字内容若未经特别声明,则遵循协议CC3.0共享协议,转载请务必注明原文链接。
3.本站部分来源于网络转载的文章信息是出于传递更多信息之目的,不意味着赞同其观点。
4.本站所有源码与软件均为原作者提供,仅供学习和研究使用。
5.如您对本网站的相关版权有任何异议,或者认为侵犯了您的合法权益,请及时通知我们处理。
火焰兔 » Node.js + Express + TypeScript:req.query 类型