ToKebabCaseKeys

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

type Converted = ToKebabCaseKeys<T>;

使用法

ToKebabCaseKeys<T>

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

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

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

type KebabUser = ToKebabCaseKeys<User>;
// => { 'user-id': number; 'first-name': string; 'user-address': { 'zip-code': string } }

型パラメータ

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