feat: added snakeCase method, it transforms text to snake case format

teclone · Jun 5, 2019 · eb9de2e · eb9de2e
1 parent 3d5aa78
commit eb9de2e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -463,6 +463,13 @@ export const camelCase = (text: string, delimiter: string | RegExp = /[-_]/): st
     }).join('');
 };
 
+/**
+ * converts text to snake like casing
+ */
+export const snakeCase = (text: string, delimiter: string | RegExp = /[-_]/): string => {
+    return text.split(delimiter).map((token) => token.toLowerCase()).join('_');
+};
+
 /**
  * pads the given target text or number with the pad with value until the target length meets
  * the given length

diff --git a/tests/index.spec.ts b/tests/index.spec.ts
@@ -489,6 +489,16 @@ describe('Utils', function() {
         });
     });
 
+    describe('.snakeCase(text: string, delimiter: string | RegExp = /[-_]/): string', function() {
+        it(`should turn the given text string into snake casing using the given delimiter`, function() {
+            expect(Utils.snakeCase('my:string', ':')).toEqual('my_string');
+        });
+
+        it(`should default the delimiter argument to /[_-]/ if not given`, function() {
+            expect(Utils.snakeCase('my-second_string')).toEqual('my_second_string');
+        });
+    });
+
     describe('.padLeft(target: string | number, length:number = 4, padWith: string | number = 0): string', function() {
 
         it(`should pad the given target to the left with the given padWith value up till the