convertToKebabCase

Convert an object's camelCase keys to kebab-case, optionally deeply, returning a new object useful for CSS or HTML attribute mapping.

Usage

convertToKebabCase converts an object's keys to kebab-case format.

import { convertToKebabCase } from '@movk/core'

const obj = {
  firstName: 'John',
  lastName: 'Doe',
  userInfo: {
    birthDate: '1990-01-01',
    phoneNumber: '123-456-7890'
  }
}

const converted = convertToKebabCase(obj)
console.log(converted)
// {
//   'first-name': 'John',
//   'last-name': 'Doe',
//   'user-info': { birthDate: '1990-01-01', phoneNumber: '123-456-7890' }
// }

const deepConverted = convertToKebabCase(obj, true)
console.log(deepConverted)
// {
//   'first-name': 'John',
//   'last-name': 'Doe',
//   'user-info': { 'birth-date': '1990-01-01', 'phone-number': '123-456-7890' }
// }

API

convertToKebabCase<T>(obj, deep?)

Converts an object's keys to kebab-case format.

Parameters

obj
T extends AnyObject required
The object to convert.
deep
boolean
Whether to deeply convert nested objects. Defaults to false.

Returns

returns
T
The converted object.

Changelog

No recent changes
Copyright © 2024 - 2026 YiXuan - MIT License