@mongez/reinforcements 2.0.2 → 2.0.4

package/README.md

@@ -812,7 +812,7 @@ Any of following will be used as a separator for the text, `.` | `-` | `whitespa
 
 ### Convert string to snake case
 
-Convert string to snake case, each word in string Separated by **whitespace** or **dashes** `toSnakeCase(string: string): string`.
+Convert string to snake case, each word in string Separated by **whitespace** or **dashes** `toSnakeCase(string: string, separator: string = '_', lowerAll: boolean = true): string`.
 
 The final output of the text will be all letters in lower case string separated by \_ **underscores**.
 
@@ -824,6 +824,26 @@ const words = "hello world";
 console.log(toSnakeCase(words)); // hello_world
 ```
 
+You can also set custom separator as second argument.
+
+```ts
+import { toSnakeCase } from "@mongez/reinforcements";
+
+const words = "hello world";
+
+console.log(toSnakeCase(words, '-')); // hello-world
+```
+
+Also setting the third argument to false will not convert letters to lower case, will keep each letter as its own.
+
+```ts
+import { toSnakeCase } from "@mongez/reinforcements";
+
+const words = "Hello World";
+
+console.log(toSnakeCase(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`.

package/cjs/Collection/ImmutableCollection.d.ts

@@ -28,6 +28,10 @@ export default class ImmutableCollection {
      * Get items in the given indexes
      */
     onlyIndexes(...indexes: number[]): ImmutableCollection;
+    /**
+     * Get items that are not in the given indexes
+     */
+    exceptIndexes(...indexes: number[]): ImmutableCollection;
     /**
      * Get items keys (indexes) as collection of string
      */
@@ -96,6 +100,10 @@ export default class ImmutableCollection {
      */
     divide(amount: number): any;
     divide(key: string, amount: number): any;
+    /**
+     * Divide the given key in each element or the element by 2
+     */
+    half(key?: string): any;
     /**
      * Get the modulus of the given amount to each element or given key in each element
      */
@@ -205,10 +213,6 @@ export default class ImmutableCollection {
      * @alias push
      */
     append(...items: any[]): ImmutableCollection;
-    /**
-     * Get items that are not in the given indexes
-     */
-    exceptIndexes(...indexes: number[]): ImmutableCollection;
     /**
      * Add the given items to the end of the array only if they don't exist
      */

package/cjs/Collection/ImmutableCollection.js

@@ -113,6 +113,20 @@ var ImmutableCollection = /** @class */ (function () {
       }),
     );
   };
+  /**
+   * Get items that are not in the given indexes
+   */
+  ImmutableCollection.prototype.exceptIndexes = function () {
+    var indexes = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+      indexes[_i] = arguments[_i];
+    }
+    return new ImmutableCollection(
+      this.items.filter(function (_, index) {
+        return !indexes.includes(index);
+      }),
+    );
+  };
   /**
    * Get items keys (indexes) as collection of string
    */
@@ -264,6 +278,12 @@ var ImmutableCollection = /** @class */ (function () {
       return item / amount;
     });
   };
+  /**
+   * Divide the given key in each element or the element by 2
+   */
+  ImmutableCollection.prototype.half = function (key) {
+    return key ? this.divide(key, 2) : this.divide(2);
+  };
   ImmutableCollection.prototype.modulus = function () {
     var args = [];
     for (var _i = 0; _i < arguments.length; _i++) {
@@ -602,20 +622,6 @@ var ImmutableCollection = /** @class */ (function () {
       tslib_es6.__spreadArray([], tslib_es6.__read(items), false),
     );
   };
-  /**
-   * Get items that are not in the given indexes
-   */
-  ImmutableCollection.prototype.exceptIndexes = function () {
-    var indexes = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-      indexes[_i] = arguments[_i];
-    }
-    return new ImmutableCollection(
-      this.items.filter(function (_, index) {
-        return !indexes.includes(index);
-      }),
-    );
-  };
   /**
    * Add the given items to the end of the array only if they don't exist
    */

package/cjs/string/toSnakeCase.d.ts

@@ -4,5 +4,5 @@
  *
  * @return string
  */
-export default function toSnakeCase(string: string, lowerAll?: boolean): string;
+export default function toSnakeCase(string: string, separator?: string, lowerAll?: boolean): string;
 //# sourceMappingURL=toSnakeCase.d.ts.map

package/cjs/string/toSnakeCase.js

@@ -6,19 +6,22 @@
  *
  * @return string
  */
-function toSnakeCase(string, lowerAll) {
+function toSnakeCase(string, separator, lowerAll) {
+  if (separator === void 0) {
+    separator = "_";
+  }
   if (lowerAll === void 0) {
     lowerAll = true;
   }
-  return string.replace(
-    /(-|\/|\s|([A-Z]))+/g,
-    function (_match, _v2, matchedUpperLetter) {
-      if (!matchedUpperLetter) return "_";
+  return string
+    .replace(/(-|\/|\s|([A-Z]))+/g, function (_match, _v2, matchedUpperLetter) {
+      if (!matchedUpperLetter) return separator;
       return (
-        "_" + (lowerAll ? matchedUpperLetter.toLowerCase() : matchedUpperLetter)
+        separator +
+        (lowerAll ? matchedUpperLetter.toLowerCase() : matchedUpperLetter)
       );
-    },
-  );
+    })
+    .replace(new RegExp("^".concat(separator)), "");
 }
 
 module.exports = toSnakeCase;

package/docs/collection.md

@@ -1524,7 +1524,7 @@ const numbers = collect([1, 2, 3, 4, 5]);
 numbers.random(2); // [3, 5]
 ```
 
-## Working With Numbers
+## Working With Math
 
 Collection provides you with a set of methods to work with numbers which will make it easier to manipulate.
 
@@ -1728,7 +1728,7 @@ const users = collect([
 users.decrement('age'); // [{ name: 'John', age: 19 }, { name: 'Jane', age: 24 }, { name: 'Jack', age: 29 }]
 ```
 
-## Multiply
+### Multiply
 
 The `multiply` method multiply the given value to each element of the array.
 
@@ -1770,7 +1770,7 @@ const users = collect([
 users.double('age'); // [{ name: 'John', age: 40 }, { name: 'Jane', age: 50 }, { name: 'Jack', age: 60 }]
 ```
 
-## Divide
+### Divide
 
 The `divide` method divide the given value to each element of the array.
 
@@ -1802,7 +1802,7 @@ try {
 }
 ```
 
-## Modulus
+### Modulus
 
 The `modulus` method returns the remainder of the division of each element of the array by the given value.
 
@@ -1878,7 +1878,7 @@ const users = collect([
 users.odd('age'); // [{ name: 'Jane', age: 25 }]
 ```
 
-## Working With Strings
+### Working With Strings
 
 The Collection provides some utilities to work with strings.
 

package/esm/Collection/ImmutableCollection.d.ts

@@ -28,6 +28,10 @@ export default class ImmutableCollection {
      * Get items in the given indexes
      */
     onlyIndexes(...indexes: number[]): ImmutableCollection;
+    /**
+     * Get items that are not in the given indexes
+     */
+    exceptIndexes(...indexes: number[]): ImmutableCollection;
     /**
      * Get items keys (indexes) as collection of string
      */
@@ -96,6 +100,10 @@ export default class ImmutableCollection {
      */
     divide(amount: number): any;
     divide(key: string, amount: number): any;
+    /**
+     * Divide the given key in each element or the element by 2
+     */
+    half(key?: string): any;
     /**
      * Get the modulus of the given amount to each element or given key in each element
      */
@@ -205,10 +213,6 @@ export default class ImmutableCollection {
      * @alias push
      */
     append(...items: any[]): ImmutableCollection;
-    /**
-     * Get items that are not in the given indexes
-     */
-    exceptIndexes(...indexes: number[]): ImmutableCollection;
     /**
      * Add the given items to the end of the array only if they don't exist
      */

package/esm/Collection/ImmutableCollection.js

@@ -101,6 +101,20 @@ var ImmutableCollection = /** @class */ (function () {
       }),
     );
   };
+  /**
+   * Get items that are not in the given indexes
+   */
+  ImmutableCollection.prototype.exceptIndexes = function () {
+    var indexes = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+      indexes[_i] = arguments[_i];
+    }
+    return new ImmutableCollection(
+      this.items.filter(function (_, index) {
+        return !indexes.includes(index);
+      }),
+    );
+  };
   /**
    * Get items keys (indexes) as collection of string
    */
@@ -252,6 +266,12 @@ var ImmutableCollection = /** @class */ (function () {
       return item / amount;
     });
   };
+  /**
+   * Divide the given key in each element or the element by 2
+   */
+  ImmutableCollection.prototype.half = function (key) {
+    return key ? this.divide(key, 2) : this.divide(2);
+  };
   ImmutableCollection.prototype.modulus = function () {
     var args = [];
     for (var _i = 0; _i < arguments.length; _i++) {
@@ -569,20 +589,6 @@ var ImmutableCollection = /** @class */ (function () {
     }
     return this.push.apply(this, __spreadArray([], __read(items), false));
   };
-  /**
-   * Get items that are not in the given indexes
-   */
-  ImmutableCollection.prototype.exceptIndexes = function () {
-    var indexes = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-      indexes[_i] = arguments[_i];
-    }
-    return new ImmutableCollection(
-      this.items.filter(function (_, index) {
-        return !indexes.includes(index);
-      }),
-    );
-  };
   /**
    * Add the given items to the end of the array only if they don't exist
    */

package/esm/string/toSnakeCase.d.ts

@@ -4,5 +4,5 @@
  *
  * @return string
  */
-export default function toSnakeCase(string: string, lowerAll?: boolean): string;
+export default function toSnakeCase(string: string, separator?: string, lowerAll?: boolean): string;
 //# sourceMappingURL=toSnakeCase.d.ts.map

package/esm/string/toSnakeCase.js

@@ -4,19 +4,22 @@
  *
  * @return string
  */
-function toSnakeCase(string, lowerAll) {
+function toSnakeCase(string, separator, lowerAll) {
+  if (separator === void 0) {
+    separator = "_";
+  }
   if (lowerAll === void 0) {
     lowerAll = true;
   }
-  return string.replace(
-    /(-|\/|\s|([A-Z]))+/g,
-    function (_match, _v2, matchedUpperLetter) {
-      if (!matchedUpperLetter) return "_";
+  return string
+    .replace(/(-|\/|\s|([A-Z]))+/g, function (_match, _v2, matchedUpperLetter) {
+      if (!matchedUpperLetter) return separator;
       return (
-        "_" + (lowerAll ? matchedUpperLetter.toLowerCase() : matchedUpperLetter)
+        separator +
+        (lowerAll ? matchedUpperLetter.toLowerCase() : matchedUpperLetter)
       );
-    },
-  );
+    })
+    .replace(new RegExp("^".concat(separator)), "");
 }
 
 export { toSnakeCase as default };

package/package.json

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