ToSnakeCaseKeys

オブジェクト型のすべてのキーを再帰的にスネークケース(snake_case)に変換します。toSnakeCaseKeys 関数の戻り値の型です。

type Converted = ToSnakeCaseKeys<T>;

使用法

ToSnakeCaseKeys<T>

キーがスネークケースに変換されたデータの型が必要なときに ToSnakeCaseKeys を使用してください。たとえば、リクエストボディを toSnakeCaseKeys で変換した結果の型を表現できます。ネストされたオブジェクトと配列内のオブジェクトのキーも再帰的に変換されます。Date や Map などの組み込みオブジェクトとプリミティブ値はそのまま保持されます。

import type { ToSnakeCaseKeys } from 'es-toolkit/types';

type User = {
  userId: number;
  firstName: string;
  userAddress: { zipCode: string };
};

type ApiUser = ToSnakeCaseKeys<User>;
// => { user_id: number; first_name: string; user_address: { zip_code: string } }

型パラメータ

• T: キーを変換する型です。