@mongez/reinforcements 2.0.4 → 2.0.6

package/README.md

@@ -767,6 +767,7 @@ The following list defines all available string utilities
 - `capitalize`
 - `toCamelCase`
 - `toSnakeCase`
+- `toKebabCase`
 - `toStudlyCase`
 - `ucfirst`
 - `toInputName`
@@ -844,6 +845,30 @@ const words = "Hello World";
 console.log(toSnakeCase(words, '-', false)); // Hello_World
 ```
 
+### Convert string to kebab case
+
+Convert string to kebab case, each word in string Separated by **whitespace** or **dashes** or **Upper Letters** `toKebabCase(string: string, lowerAll: boolean = true): string`.
+
+The final output of the text will be all letters in lower case string separated by \- **dashes**.
+
+```ts
+import { toKebabCase } from "@mongez/reinforcements";
+
+const words = "hello world";
+
+console.log(toKebabCase(words)); // hello-world
+```
+
+If you want to ignore the lower case conversion, set the second argument to false.
+
+```ts
+import { toKebabCase } from "@mongez/reinforcements";
+
+const words = "Hello World";
+
+console.log(toKebabCase(words, false)); // Hello-World
+```
+
 ### Convert string to studly case
 
 Convert string to studly case, each word in string Separated by **whitespace**, **underscores** or **dashes** `toStudlyCase(string: string, separator: string = "-|\\.|_|\\s"): string`.
@@ -1197,6 +1222,8 @@ If you want to contribute to this package, you can check the [todo list page](./
 
 ## Change Log
 
+- 2.0.5 (25 Oct 2022)
+  - Added `toKebabCase` function
 - 2.0.0 (24 Oct 2022)
   - Fully refactored the code.
   - Added Immutable Collections class.

package/cjs/index.d.ts

@@ -43,6 +43,7 @@ export { default as rtrim } from "./string/rtrim";
 export { ARABIC_PATTERN, default as startsWithArabic, } from "./string/startsWithArabic";
 export { default as toCamelCase } from "./string/toCamelCase";
 export { default as toInputName } from "./string/toInputName";
+export { default as toKebabCase } from "./string/toKebabCase";
 export { default as toSnakeCase } from "./string/toSnakeCase";
 export { default as toStudlyCase } from "./string/toStudlyCase";
 export { default as trim } from "./string/trim";

package/cjs/index.js

@@ -47,6 +47,7 @@ var rtrim = require("./string/rtrim.js");
 var startsWithArabic = require("./string/startsWithArabic.js");
 var toCamelCase = require("./string/toCamelCase.js");
 var toInputName = require("./string/toInputName.js");
+var toKebabCase = require("./string/toKebabCase.js");
 var toSnakeCase = require("./string/toSnakeCase.js");
 var toStudlyCase = require("./string/toStudlyCase.js");
 var trim = require("./string/trim.js");
@@ -102,6 +103,7 @@ exports.ARABIC_PATTERN = startsWithArabic.ARABIC_PATTERN;
 exports.startsWithArabic = startsWithArabic["default"];
 exports.toCamelCase = toCamelCase;
 exports.toInputName = toInputName;
+exports.toKebabCase = toKebabCase;
 exports.toSnakeCase = toSnakeCase;
 exports.toStudlyCase = toStudlyCase;
 exports.trim = trim;

package/cjs/string/toKebabCase.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert current string to kebab case
+ */
+export default function toKebabCase(string: string, lowerAll?: boolean): string;
+//# sourceMappingURL=toKebabCase.d.ts.map

package/cjs/string/toKebabCase.js

@@ -0,0 +1,15 @@
+"use strict";
+
+var toSnakeCase = require("./toSnakeCase.js");
+
+/**
+ * Convert current string to kebab case
+ */
+function toKebabCase(string, lowerAll) {
+  if (lowerAll === void 0) {
+    lowerAll = true;
+  }
+  return toSnakeCase(string, "-", lowerAll);
+}
+
+module.exports = toKebabCase;

package/esm/index.d.ts

@@ -43,6 +43,7 @@ export { default as rtrim } from "./string/rtrim";
 export { ARABIC_PATTERN, default as startsWithArabic, } from "./string/startsWithArabic";
 export { default as toCamelCase } from "./string/toCamelCase";
 export { default as toInputName } from "./string/toInputName";
+export { default as toKebabCase } from "./string/toKebabCase";
 export { default as toSnakeCase } from "./string/toSnakeCase";
 export { default as toStudlyCase } from "./string/toStudlyCase";
 export { default as trim } from "./string/trim";

package/esm/index.js

@@ -49,6 +49,7 @@ export {
 } from "./string/startsWithArabic.js";
 export { default as toCamelCase } from "./string/toCamelCase.js";
 export { default as toInputName } from "./string/toInputName.js";
+export { default as toKebabCase } from "./string/toKebabCase.js";
 export { default as toSnakeCase } from "./string/toSnakeCase.js";
 export { default as toStudlyCase } from "./string/toStudlyCase.js";
 export { default as trim } from "./string/trim.js";

package/esm/string/toKebabCase.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert current string to kebab case
+ */
+export default function toKebabCase(string: string, lowerAll?: boolean): string;
+//# sourceMappingURL=toKebabCase.d.ts.map

package/esm/string/toKebabCase.js

@@ -0,0 +1,13 @@
+import toSnakeCase from "./toSnakeCase.js";
+
+/**
+ * Convert current string to kebab case
+ */
+function toKebabCase(string, lowerAll) {
+  if (lowerAll === void 0) {
+    lowerAll = true;
+  }
+  return toSnakeCase(string, "-", lowerAll);
+}
+
+export { toKebabCase as default };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mongez/reinforcements",
-    "version": "2.0.4",
+    "version": "2.0.6",
     "description": "A lightweight package to give a massive reinforcements to variant types of data in Nodejs/Javascript",
     "main": "./cjs/index.js",
     "dependencies": {