Skip to content

ToPascalCaseKeys

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

typescript
type Converted = ToPascalCaseKeys<T>;

使用法

ToPascalCaseKeys<T>

キーがパスカルケースに変換されたデータの型が必要なときに ToPascalCaseKeys を使用してください。たとえば、外部 API に送るデータを toPascalCaseKeys で変換した結果の型を表現できます。ネストされたオブジェクトと配列内のオブジェクトのキーも再帰的に変換されます。DateMap などの組み込みオブジェクトとプリミティブ値はそのまま保持されます。

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

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

type PascalUser = ToPascalCaseKeys<User>;
// => { UserId: number; FirstName: string; UserAddress: { ZipCode: string } }

型パラメータ

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

MIT ライセンスの下で配布されています。