jsly 3.0.2 → 3.0.3

package/README.md

@@ -130,15 +130,27 @@ try {
 ### 字符串与对象命名转换
 
 ```javascript
-import { camelToSnake, snakeToCamel, toggleConvertCase, convertObjKeysToCamel } from 'jsly'
+import { camelToSnake, snakeToCamel, toggleConvertCase, convertKeys } from 'jsly'
 
+// 字符串转换
 console.log(camelToSnake('myVariable')) // my_variable
 console.log(snakeToCamel('my_variable')) // myVariable
 console.log(toggleConvertCase('myVariable')) // my_variable
 console.log(toggleConvertCase('my_variable')) // myVariable
 
-const obj = { my_variable: 123, another_key: 'abc' }
-console.log(convertObjKeysToCamel(obj)) // { myVariable: 123, anotherKey: 'abc' }
+// 对象键名转换（默认只转换首层）
+console.log(convertKeys({ user_name: 'Tom', user_info: { phone_number: '123' } }, 'camel'))
+// => { userName: 'Tom', userInfo: { phone_number: '123' } }
+
+// 递归转换所有层级
+console.log(convertKeys({ user_name: 'Tom', user_info: { phone_number: '123' } }, 'camel', true))
+// => { userName: 'Tom', userInfo: { phoneNumber: '123' } }
+
+console.log(convertKeys({ userName: 'Tom', userInfo: { phoneNumber: '123' } }, 'snake'))
+// => { user_name: 'Tom', user_info: { phoneNumber: '123' } }
+
+console.log(convertKeys({ userName: 'Tom', userInfo: { phoneNumber: '123' } }, 'snake', true))
+// => { user_name: 'Tom', user_info: { phone_number: '123' } }
 
 ```
 

package/dist/index.cjs.js

@@ -7351,39 +7351,47 @@ function toggleConvertCase(str) {
 }
 
 /**
- * 递归转换对象或数组的键名格式
- * 
- * @param {object|array} data - 需要转换的对象或数组
- * @param {'camel'|'snake'} type - 指定目标格式：'camel' 转小驼峰；'snake' 转下划线
- * @returns {object|array} - 转换后的新对象或数组
+ * 转换对象的键名格式（支持可选递归）
+ *
+ * @param {object} obj - 需要转换的对象
+ * @param {'camel'|'snake'} targetType - 目标格式：'camel' 转小驼峰；'snake' 转下划线
+ * @param {boolean} [deep=false] - 是否递归转换（默认 false，仅转换首层）
+ * @returns {object} - 转换后的新对象
  *
  * @example
  * convertKeys({ user_name: 'Tom', user_info: { phone_number: '123' } }, 'camel')
+ * // => { userName: 'Tom', userInfo: { phone_number: '123' } }
+ *
+ * @example
+ * convertKeys({ user_name: 'Tom', user_info: { phone_number: '123' } }, 'camel', true)
  * // => { userName: 'Tom', userInfo: { phoneNumber: '123' } }
  *
  * @example
  * convertKeys({ userName: 'Tom', userInfo: { phoneNumber: '123' } }, 'snake')
+ * // => { user_name: 'Tom', user_info: { phoneNumber: '123' } }
+ *
+ * @example
+ * convertKeys({ userName: 'Tom', userInfo: { phoneNumber: '123' } }, 'snake', true)
  * // => { user_name: 'Tom', user_info: { phone_number: '123' } }
  */
-function convertKeys(data, type = 'camel') {
-  if (data === null || typeof data !== 'object') {
-    return data; // 原始类型直接返回
+function convertKeys(obj, targetType = 'camel', deep = false) {
+  if (obj === null || typeof obj !== 'object' || Array.isArray(obj)) {
+    throw new Error('convertKeys 仅支持对象类型');
   }
-  if (!['camel', 'snake'].includes(type)) {
-    throw new Error("convertKeys type must be 'camel' or 'snake'.");
+  if (!['camel', 'snake'].includes(targetType)) {
+    throw new Error("convertKeys targetType 必须是 'camel' 或 'snake'");
   }
+  const result = {};
+  for (const [key, value] of Object.entries(obj)) {
+    const newKey = targetType === 'camel' ? snakeToCamel(key) : camelToSnake(key);
 
-  // 处理数组
-  if (Array.isArray(data)) {
-    return data.map(item => convertKeys(item, type));
+    // 如果开启递归并且值是对象，则递归转换
+    if (deep && value && typeof value === 'object' && !Array.isArray(value)) {
+      result[newKey] = convertKeys(value, targetType, deep);
+    } else {
+      result[newKey] = value;
+    }
   }
-
-  // 处理对象
-  const result = {};
-  Object.entries(data).forEach(([key, value]) => {
-    const newKey = type === 'camel' ? snakeToCamel(key) : camelToSnake(key);
-    result[newKey] = convertKeys(value, type);
-  });
   return result;
 }