ExpressのRequestとResponseに型を付ける

ようこそ

型定義のインストール

npm install express
npm install --save-dev @types/express

基本的なルートの型

import { Request, Response } from 'express';
app.get('/users', (req: Request, res: Response) => {
  res.json({ users: [] });
});

ルートパラメーターに型を付ける

interface Params { id: string; }
app.get('/users/:id', (req: Request<Params>, res: Response) => {
  const { id } = req.params;
});

リクエストボディに型を付ける

interface CreateUser { name: string; email: string; }
app.post('/users', (req: Request<{}, {}, CreateUser>, res: Response) => {
  const { name, email } = req.body;
});

クエリパラメーターに型を付ける

interface Query { page?: string; limit?: string; }
app.get('/users', (req: Request<{}, {}, {}, Query>, res: Response) => {
  const page = parseInt(req.query.page ?? '1');
});

Requestの拡張

declare global {
  namespace Express {
    interface Request { user?: User; }
  }
}

Responseに型を付ける

app.get('/me', (req: Request, res: Response<User>) => {
  res.json(req.user!); // response body must be User
});

エラーハンドラーの型

import { ErrorRequestHandler } from 'express';
const errHandler: ErrorRequestHandler = (err, req, res, next) => {
  res.status(500).json({ error: err.message });
};

型付きRouterの使用

import { Router } from 'express';
const router = Router();
router.get('/:id', (req: Request<{ id: string }>, res) => {});

検証ミドルウェア

function parseBody<T>(schema: ZodSchema<T>) {
  return (req: Request, res: Response, next: NextFunction) => {
    req.body = schema.parse(req.body);
    next();
  };
}

クイックチェック

まとめ