Express + TS API開発で先にやっておきたいリスト

module.exports = {
  root: true,
  env: {
    es6: true,
    node: true,
  },
  parser: '@typescript-eslint/parser',
  parserOptions: {
    sourceType: 'module',
    ecmaVersion: 2019,
    tsconfigRootDir: __dirname,
    project: ['./tsconfig.eslint.json'],
  },
  plugins: ['@typescript-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:@typescript-eslint/recommended-requiring-type-checking',
  ],
};

{
  "extends": "./tsconfig.json",
  "include": ["./**/*.ts", ".eslintrc.js"],
  "exclude": ["node_modules", "dist"]
}

// 未使用引数が警告されるので (req, res, next) => {...} というリクエストハンドラが書けない
'@typescript-eslint/no-unused-vars': 'off',

// Expressのモジュールを使うと明示し難い型が結構あるので、常に戻り値を定義するルールは使いづらい
'@typescript-eslint/explicit-module-boundary-types': 'off',

// メジャーかつ型定義が未成熟なライブラリ(mysqlとか)が割とあるので、ts-ignoreの利用場面は視野に入れる
'@typescript-eslint/ban-ts-comment': 'off',

// usersテーブルの1レコードをマッピングしたインターフェイス

export type User = {
  /**
   * ID (PK)
   *
   * - 自動採番
   */
  id: number;
  /**
   * ユーザ名
   */
  username: string;
  /**
   * 年齢
   */
  age: number;
  /**
   * 誕生日
   */
  birthday: Date;
  /**
   * 作成日時
   *
   * - `DEFAULT CURRENT_TIMESTAMP`により自動で作成される
   */
  created_at: Date;
  /**
   * 更新日時
   *
   * - `DEFAULT CURRENT_TIMESTAMP`により自動で作成される
   * - `ON UPDATE CURRENT_TIMESTAMP`により自動で更新される
   */
  updated_at: Date;
};

export type ReqQueryFindAllUsers = {
  /**
   * ユーザ名
   */
  username: string;
  /**
   * 年齢
   */
  age: string;
  /**
   * 誕生日
   */
  birthday: string;
  /**
   * 作成日時
   */
  created_at: string;
  /**
   * 更新日時
   */
  updated_at: string;
};

export type ReqBodyCreateUser = {
  /**
   * ユーザ名
   */
  username: string;
  /**
   * 年齢
   */
  age: number;
  /**
   * 誕生日
   */
  birthday: string;
};

export type ReqBodyUpdateUser = {
  /**
   * 年齢
   */
  age: number;
  /**
   * 誕生日
   */
  birthday: string;
};

interface Request<
	P = core.ParamsDictionary, // <-- req.params (リクエストパスパラメータ)
	ResBody = any, // 
	ReqBody = any, // <-- req.body (リクエストボディ)
	ReqQuery = core.Query, // <-- req.query (リクエストクエリパラメータ)
	Locals extends Record<string, any> = Record<string, any>
> extends core.Request<P, ResBody, ReqBody, ReqQuery, Locals> {}

export type ReqFindAllUsers = Request<unknown, unknown, unknown, ReqQueryFindAllUsers>;

/* 微妙 */
(req: Request, res: Resoponse, next: NextFunction) => {
  // ...
}

/* 望ましい */
(req: ReqFindAllUsers, res: Resoponse, next: NextFunction) => {
  // ...
}

export type LoggedInUser = {
  id: number;
  // ...
};