feat(toSnakeObject): Add toSnakeObject export to object index

[gweesin]

Add toSnakeObject Utility Function

Summary

Added a new utility function toSnakeObject that converts the keys of an object to snake_case. This function is designed to handle objects with any depth of nesting and ensures that the original object remains unaltered.

Implementation Details

• The function accepts an object with keys in any case format.
• It returns a new object with all keys converted to snake_case.
• The function is recursive, allowing it to handle nested objects and arrays.
• Utilizes a helper function snakeCase to perform the key conversion.
• Ensures immutability by not modifying the original object.

Usage Examples

import { toSnakeObject } from 'es-toolkit/object';

// Convert object keys to snake_case
const user = {
  firstName: 'John',
  lastName: 'Doe',
  contactInfo: {
    emailAddress: '[email protected]',
    phoneNumber: '123-456-7890'
  }
};

const formattedUser = toSnakeObject(user);
console.log(formattedUser);
// Output: {
//   first_name: 'John',
//   last_name: 'Doe',
//   contact_info: {
//     email_address: '[email protected]',
//     phone_number: '123-456-7890'
//   }
// }

This function is particularly useful for applications that require consistent key formatting, such as when interfacing with APIs that expect snake_case keys.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
es-toolkit	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 28, 2025 7:41am