utils-lib-js 2.0.14 → 2.0.15

package/README.en.md

@@ -62,9 +62,9 @@ With reference to https://gitee.com/DieHunter/utils-lib-js/blob/master/src/types
 
 Generates random integers within the specified range.
 
-- 'min' : indicates the minimum value (including).
-- 'max' : indicates the maximum value (inclusive).
-- 'bool' : Indicates whether the maximum value is contained. The default value is false.
+- `min` : indicates the minimum value (including).
+- `max` : indicates the maximum value (inclusive).
+- `bool` : Indicates whether the maximum value is contained. The default value is false.
 
 ```javascript
 const randomNumber = randomNum(1, 10);
@@ -75,7 +75,7 @@ console.log(randomNumber); // Generates a random integer between 1 and 10
 
 Parses URL query parameters into objects.
 
-- 'url' : indicates the URL containing the query parameter.
+- `url` : indicates the URL containing the query parameter.
 
 ```javascript
 const url = "https://example.com/path?param1=value1&param2=value2";
@@ -88,8 +88,8 @@ console.log(params);
 
 Converts the object to a URL query parameter and concatenates it with the original URL.
 
-- 'url' : indicates the original URL.
-- 'query' : object containing query parameters.
+- `url` : indicates the original URL.
+- `query` : object containing query parameters.
 
 ```javascript
 const url = "https://example.com/path";
@@ -103,7 +103,7 @@ console.log(newUrl);
 
 Get the type of data.
 
-- 'data' : indicates the data to be checked.
+- `data` : indicates the data to be checked.
 
 ```javascript
 const dataType = getType("Hello, World!");
@@ -114,8 +114,8 @@ console.log(dataType); // Output: string
 
 Check whether the data type is in the whitelist.
 
-- 'data' : indicates the data to be checked.
-- 'whiteList' : indicates the list of allowed data types.
+- `data` : indicates the data to be checked.
+- `whiteList` : indicates the list of allowed data types.
 
 ```javascript
 const data = 42;
@@ -124,15 +124,28 @@ const isTypeAllowed = getTypeByList(data, allowedTypes);
 console.log(isTypeAllowed); // Output: true
 ```
 
+##### 6. `toKebabCase(camelCase: string, separator: string = "-"): string`
+
+The hump name is converted to a hyphenated name
+
+- `camelCase` : hump type variable
+- `separator` : indicates the separator
+
+```javascript
+const camelCase = "fontSize";
+const kebabCase = toKebabCase(camelCase);
+console.log(kebabCase); // Output: font-size
+```
+
 #### object module
 
 ##### 1. `getValue(object: object, key: string, defaultValue: any = ''): any`
 
 Gets the value of the specified path in the object.
 
-- 'object' : indicates the target object.
-- 'key' : the path to the value to be obtained.
-- 'defaultValue' : Default value, returned if the path does not exist.
+- `object` : indicates the target object.
+- `key` : the path to the value to be obtained.
+- `defaultValue` : Default value, returned if the path does not exist.
 
 ```javascript
 const obj = { a: { b: { c: 42 } } };
@@ -144,9 +157,9 @@ console.log(value); // Output: 42
 
 Sets the value of the specified path in the object.
 
-- 'object' : indicates the target object.
-- 'key' : path to the value to be set.
-- 'value' : indicates the value to be set.
+- `object` : indicates the target object.
+- `key` : path to the value to be set.
+- `value` : indicates the value to be set.
 
 ```javascript
 const obj = { a: { b: { c: 42 } } };
@@ -158,9 +171,9 @@ console.log(obj); // Output: {a: {b: {c: 42, d: 'new value'}}}
 
 Mixes the properties of the source object into the target object.
 
-- 'target' : indicates the target object.
-- 'source' : indicates the source object.
-- 'overwrite' : Whether to overwrite an existing attribute. The default is' false '.
+- `target` : indicates the target object.
+- `source` : indicates the source object.
+- `overwrite` : Whether to overwrite an existing attribute. The default is' false '.
 
 ```javascript
 const target = { a: 1 };
@@ -173,7 +186,7 @@ console.log(result); // Output: {a: 1, b: 2}
 
 Inverts the key-value pair of an enumeration object.
 
-- 'target' : enumeration object to be reversed.
+- `target` : enumeration object to be reversed.
 
 ```javascript
 const enumObj = { key1: "value1", key2: "value2" };
@@ -185,8 +198,8 @@ console.log(invertedEnum); // Output: {value1: 'key1', value2: 'key2'}
 
 Check whether the value is of a non-object type.
 
-- 'source' : indicates the value to be checked.
-- 'type' : indicates the data type.
+- `source` : indicates the value to be checked.
+- `type` : indicates the data type.
 
 ```javascript
 const result = isNotObject(42, "number");
@@ -197,7 +210,7 @@ console.log(result); // Output: false
 
 Deep clone object.
 
-- 'target' : indicates the object to be cloned.
+- `target` : indicates the object to be cloned.
 
 ```javascript
 const obj = { a: { b: { c: 42 } } };
@@ -209,8 +222,8 @@ console.log(clonedObj); // Output: {a: {b: {c: 42}}}
 
 Creates an object of a specific type based on its type.
 
-- 'type' : indicates the type of the object to be created.
-- 'source' : initializes the data of the object.
+- `type` : indicates the type of the object to be created.
+- `source` : initializes the data of the object.
 
 ```javascript
 const array = createObjectVariable("array", [1, 2, 3]);
@@ -221,7 +234,7 @@ console.log(array); // Output: [1, 2, 3]
 
 Create objects using a prototype chain.
 
-- 'source' : prototype object.
+- `source` : prototype object.
 
 ```javascript
 const protoObj = { a: 1 };
@@ -233,8 +246,8 @@ console.log(newObj.a); // Output: 1
 
 Inherit the prototype chain.
 
-- 'source' : prototype chain of the parent object.
-- 'target' : constructor of the child object.
+- `source` : prototype chain of the parent object.
+- `target` : constructor of the child object.
 
 ```javascript
 function Parent() {}
@@ -252,9 +265,9 @@ childInstance.method(); // Output: Hello from parent
 
 Gets a singleton instance of a class.
 
-- 'classProto' : The prototype chain of the class.
-- 'overwrite' : Whether to overwrite an existing instance. The default is' false '.
-- 'params' : arguments to the class constructor.
+- `classProto` : The prototype chain of the class.
+- `overwrite` : Whether to overwrite an existing instance. The default is' false '.
+- `params` : arguments to the class constructor.
 
 ```javascript
 class Singleton {
@@ -273,7 +286,7 @@ console.log(instance1 === instance2); // Output: false
 
 Add a decorator to the class.
 
-- 'params' : properties and methods to add.
+- `params` : properties and methods to add.
 
 ```javascript
 @classDecorator({
@@ -291,7 +304,7 @@ instance.additionalMethod(); // Output: Additional method
 
 Converts a JSON string to an object.
 
-- 'target' : JSON string to be converted.
+- `target` : JSON string to be converted.
 
 ```javascript
 const jsonString = '{"key": "value"}';
@@ -303,7 +316,7 @@ console.log(jsonObject); // Output: {key: 'value'}
 
 Converts the object to a JSON string.
 
-- 'target' : indicates the object to be converted.
+- `target` : indicates the object to be converted.
 
 ```javascript
 const obj = { key: "value" };
@@ -315,7 +328,7 @@ console.log(jsonString); // Output: '{"key":"value"}'
 
 Check whether it is a browser window.
 
-- 'win' : indicates the object to be checked.
+- `win` : indicates the object to be checked.
 
 ```javascript
 const isBrowserWindow = isWindow(window);
@@ -326,7 +339,7 @@ console.log(isBrowserWindow); // Output: true
 
 Creates an object whose prototype is empty.
 
-- 'init' : initializes the object.
+- `init` : initializes the object.
 
 ```javascript
 const o = emptyObject({ name: "hunter" });
@@ -340,7 +353,7 @@ console.log(o.__proto__, o2.__proto__); // Output: undefined, [Object: null prot
 
 Randomly sort the array.
 
-- 'arr' : array to sort.
+- `arr` : array to sort.
 
 ```javascript
 const originalArray = [1, 2, 3, 4, 5];
@@ -353,7 +366,7 @@ console.log(randomizedArray);
 
 Removes duplicate elements from the array.
 
-- 'arr' : array to process.
+- `arr` : array to process.
 
 ```javascript
 const arrayWithDuplicates = [1, 2, 2, 3, 4, 4, 5];
@@ -366,8 +379,8 @@ console.log(uniqueArray);
 
 Reduces the dimension of multiple nested arrays.
 
-- 'arr' : array to be reduced.
-- 'result' : The array used to store the result. The default is an empty array.
+- `arr` : array to be reduced.
+- `result` : The array used to store the result. The default is an empty array.
 
 ```javascript
 const nestedArray = [1, [2, [3, [4]], 5]];
@@ -382,8 +395,8 @@ console.log(demotedArray);
 
 Limits how often a function is called within a specified period of time.
 
-- 'fn' : function to be executed.
-- 'time' : indicates the time interval (milliseconds).
+- `fn` : function to be executed.
+- `time` : indicates the time interval (milliseconds).
 
 ```javascript
 const throttledFunction = throttle(
@@ -397,8 +410,8 @@ throttledFunction(); // This command is executed only after 1 second
 
 Limits the continuous invocation of a function for a specified period of time.
 
-- 'fn' : function to be executed.
-- 'time' : indicates the time interval (milliseconds).
+- `fn` : function to be executed.
+- `time` : indicates the time interval (milliseconds).
 
 ```javascript
 const debouncedFunction = debounce(
@@ -412,7 +425,7 @@ debouncedFunction(); // Called multiple times within 1 second, only the last tim
 
 Create a flat Promise delay object that can be set to time out after a certain amount of time.
 
-- 'timer' : indicates the timeout period (milliseconds). The default value is 0.
+- `timer` : indicates the timeout period (milliseconds). The default value is 0.
 
 ```javascript
 const deferFn = () => {
@@ -432,7 +445,7 @@ delayFn().catch(console.error); // Timeout output
 
 Catches an Error for an asynchronous operation and returns' [Error, null] 'or' [null, result] '.
 
-- 'defer' : The Promise object for the asynchronous operation.
+- `defer` : The Promise object for the asynchronous operation.
 
 ```javascript
 const asyncOperation = new Promise((resolve, reject) => {
@@ -471,10 +484,10 @@ clear(); // Cancel the execution
 
 Creates and returns an HTML element.
 
-- 'ele' : element type or existing HTMLElement object, optional, default is 'div'.
-- 'style' : The style object of the element, optional.
-- 'attr' : attribute object of the element, optional.
-- 'parent' : indicates the parent of the element. This parameter is optional.
+- `ele` : element type or existing HTMLElement object, optional, default is 'div'.
+- `style` : The style object of the element, optional.
+- `attr` : attribute object of the element, optional.
+- `parent` : indicates the parent of the element. This parameter is optional.
 
 ```javascript
 const options = {
@@ -494,9 +507,9 @@ const createdElement = createElement(options);
 
 Add event listeners to the element.
 
-- 'ele' : target element.
-- 'type' : indicates the type of the event.
-- 'handler' : event handler.
+- `ele` : target element.
+- `type` : indicates the type of the event.
+- `handler` : event handler.
 
 ```javascript
 const button = document.getElementById("myButton");
@@ -508,7 +521,7 @@ addHandler(button, "click", handleClick);
 
 Prevent events from bubbling.
 
-- 'event' : indicates an event object.
+- `event` : indicates an event object.
 
 ```javascript
 const handleClick = (event) => {
@@ -521,7 +534,7 @@ const handleClick = (event) => {
 
 Default behavior to block events.
 
-- 'event' : indicates an event object.
+- `event` : indicates an event object.
 
 ```javascript
 const handleFormSubmit = (event) => {
@@ -534,9 +547,9 @@ const handleFormSubmit = (event) => {
 
 Removes an element's event listener.
 
-- 'ele' : target element.
-- 'type' : indicates the type of the event.
-- 'handler' : event handler to be removed.
+- `ele` : target element.
+- `type` : indicates the type of the event.
+- `handler` : event handler to be removed.
 
 ```javascript
 const button = document.getElementById("myButton");
@@ -550,8 +563,8 @@ removeHandler(button, "click", handleClick);
 
 Trigger a custom event.
 
-- 'ele' : target element.
-- 'data' : indicates the data of a custom event.
+- `ele` : target element.
+- `data` : indicates the data of a custom event.
 
 ```javascript
 const customEvent = new CustomEvent("customEvent", {
@@ -567,8 +580,8 @@ dispatchEvent(targetElement, customEvent);
 
 Store values to local storage.
 
-- 'key' : specifies the name of the key.
-- 'val' : The value to be stored.
+- `key` : specifies the name of the key.
+- `val` : The value to be stored.
 
 ```javascript
 const userData = { username: "john_doe", email: "john@example.com" };
@@ -579,7 +592,7 @@ setStorage("user_data", userData);
 
 Gets the value from local storage.
 
-- 'key' : specifies the key name to be obtained.
+- `key` : specifies the key name to be obtained.
 
 ```javascript
 const storedUserData = getStorage("user_data");
@@ -591,7 +604,7 @@ console.log(storedUserData);
 
 Clear the value from the local store.
 
-- 'key' : specifies the name of the key to be cleared. If no key name is provided, all storage is cleared.
+- `key` : specifies the name of the key to be cleared. If no key name is provided, all storage is cleared.
 
 ```javascript
 clearStorage("user_data"); // Clear the stored value for a specific key name
@@ -605,9 +618,9 @@ clearStorage(); // Clear all locally stored values
 
 Output logs in one line.
 
-- 'str' : The string to be output.
-- 'overwrite' : Whether to overwrite the current line. The default is' false '.
-- 'wrap' : Whether to wrap lines after output, defaults to 'true'.
+- `str` : The string to be output.
+- `overwrite` : Whether to overwrite the current line. The default is' false '.
+- `wrap` : Whether to wrap lines after output, defaults to 'true'.
 
 ```javascript
 logOneLine("This is a single line log message.");
@@ -617,11 +630,11 @@ logOneLine("This is a single line log message.");
 
 Output a loop animation in the console.
 
-- 'opts' : an optional parameter object containing the following properties:
+- `opts` : an optional parameter object containing the following properties:
 - `loopList` : animation character list, the default is `[' \ \ ', '|', '/', '-', '-']`.
-- 'isStop' : Whether to stop the loop. The default is' false '.
-- 'timer' : Animation switch interval (milliseconds), default is' 100 '.
-- 'index' : indicates the index of the current animated character. The default value is 0.
+- `isStop` : Whether to stop the loop. The default is' false '.
+- `timer` : Animation switch interval (milliseconds), default is' 100 '.
+- `index` : indicates the index of the current animated character. The default value is 0.
 
 ```javascript
 logLoop(); // Start the default loop animation
@@ -636,7 +649,7 @@ logLoop({ loopList: ["-", "+", "-", "+"], timer: 200 }); // Start a custom loop
 A class that provides frame animation.
 
 - `start(duration? : number): void ': Starts frame animation, optional parameter' duration 'is frame number control.
-- 'stop(): void' : stops frame animation.
+- `stop(): void` : stops frame animation.
 
 ```javascript
 const animateFrame = new AnimateFrame((timestamp) => {
@@ -653,9 +666,9 @@ animateFrame.stop(); // Stop frame animation
 
 Calculate the coordinates of points on the quadratic Bessel curve.
 
-- '\_x' : x coordinates of control point 1.
-- '\_y' : y coordinate of control point 1.
-- 't' : indicates the time parameter. The value ranges from 0 to 1.
+- `\_x` : x coordinates of control point 1.
+- `\_y` : y coordinate of control point 1.
+- `t` : indicates the time parameter. The value ranges from 0 to 1.
 
 ```javascript
 const result = quadraticBezier(0, 0, 1, 1, 0.5);
@@ -667,11 +680,11 @@ console.log(result);
 
 Calculate the coordinates of points on a cubic Bezier curve.
 
-- '\_x1' : x coordinate of control point 1.
-- '\_y1' : y coordinate of control point 1.
-- '\_x2' : control point 2 x coordinates.
-- '\_y2' : y coordinate of control point 2.
-- 't' : indicates the time parameter. The value ranges from 0 to 1.
+- `\_x1` : x coordinate of control point 1.
+- `\_y1` : y coordinate of control point 1.
+- `\_x2` : control point 2 x coordinates.
+- `\_y2` : y coordinate of control point 2.
+- `t` : indicates the time parameter. The value ranges from 0 to 1.
 
 ```javascript
 const result = cubicBezier(0, 0, 0.5, 1, 0.5);
@@ -696,7 +709,7 @@ console.log(result);
 Calculate the number of combinations.
 
 - n: indicates the total number.
-- 'k' : indicates the number of selected items.
+- `k` : indicates the number of selected items.
 
 ```javascript
 const result = combination(5, 2);
@@ -708,8 +721,8 @@ console.log(result);
 
 Calculate the point coordinates on the NTH Bezier curve.
 
-- 'points' : array of control points. Each point is a second-order array.
-- 't' : indicates the time parameter. The value ranges from 0 to 1.
+- `points` : array of control points. Each point is a second-order array.
+- `t` : indicates the time parameter. The value ranges from 0 to 1.
 
 ```javascript
 const points = [

package/README.md

@@ -124,6 +124,19 @@ const isTypeAllowed = getTypeByList(data, allowedTypes);
 console.log(isTypeAllowed); // 输出: true
 ```
 
+##### 6. `toKebabCase(camelCase: string, separator: string = "-"): string`
+
+驼峰式命名转换为连字符式命名
+
+- `camelCase`: 驼峰式变量
+- `separator`: 分隔符
+
+```javascript
+const camelCase = 'fontSize';
+const kebabCase = toKebabCase(camelCase);
+console.log(kebabCase); // 输出: font-size
+```
+
 #### object 模块
 
 ##### 1. `getValue(object: object, key: string, defaultValue: any = ''): any`

package/dist/bundle/base.d.ts

@@ -5,11 +5,13 @@ export declare const urlSplit: IUrlSplit;
 export declare const urlJoin: IUrlJoin;
 export declare const getType: IGetType<types>;
 export declare const getTypeByList: IGetTypeByList;
+export declare const toKebabCase: (camelCase: string, separator?: string) => string;
 declare const _default: {
     randomNum: IRandomNum;
     urlSplit: IUrlSplit;
     urlJoin: IUrlJoin;
     getType: IGetType<types>;
     getTypeByList: IGetTypeByList;
+    toKebabCase: (camelCase: string, separator?: string) => string;
 };
 export default _default;

package/dist/bundle/index.d.ts

@@ -52,6 +52,7 @@ declare const _default: {
     urlJoin: import("./types").IUrlJoin;
     getType: import("./types").IGetType<import("./static").types>;
     getTypeByList: import("./types").IGetTypeByList;
+    toKebabCase: (camelCase: string, separator?: string) => string;
     getValue: import("./types").IGetValue;
     setValue: import("./types").ISetValue;
     mixIn: import("./types").IMixIn;