@ukon1990/js-utilities - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

dist/utils/object.util.d.ts

@@ -8,4 +8,4 @@ import { Difference } from "../models/difference.model";
     private static cloneField;
-    static isEqual(object1: Object, object2: Object): boolean;
+    static isEqual(object1: object, object2: object): boolean;
     static getDifference(object1: object | any, object2: object | any, ignoreFields?: any): Array<Difference>;
 }

dist/utils/object.util.js

@@ -48,11 +48,11 @@ "use strict";
     }
-    static cloneField(object, key, obj) {
+    static cloneField(object, key, targetObject) {
         if (array_util_1.ArrayUtil.isArray(object[key])) {
-            obj[key] = array_util_1.ArrayUtil.clone(object[key]);
+            targetObject[key] = array_util_1.ArrayUtil.clone(object[key]);
         }
         else if (ObjectUtil.isObject(object[key])) {
-            obj[key] = ObjectUtil.clone(object[key]);
+            targetObject[key] = ObjectUtil.clone(object[key]);
         }
         else {
-            obj[key] = object[key];
+            targetObject[key] = object[key];
         }
@@ -59,0 +59,0 @@ }

package.json

 {
   "name": "@ukon1990/js-utilities",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A light weight package for object and array manipulation. As well as some utilities for matching text.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 # Javascript utilities
 This is a small package with some utilities.
 
-More description inc later.
+## ObjectUtil
+* `isObject(value)` - Checks if a value is an object and not array
+* `overwrite(fromObject, toObject)` - Replaces all the values of one objects with another object
+* `clone(object)` - Returns a cloned version of an object. Removing all child object references.
+* `isEqual(object1, object2)` - Checks if two objects are equal regardless of object reference.
+* `getDifference(object1, object2)` - Returns an array of object differences as `Difference` objects.
+
+## ArrayUtil
+* `isObject(value)` - Checks if a value is an object and not array
+* `overwrite(fromArray, toArray)` - Replaces all the values of one array with another array
+* `clone(array)` - Returns a cloned version of an array. Removing all child object references.
+* `isEqual(array1, array2)` - Checks if two arrays are equal regardless of object reference.
+* `getDifference(array1, array2)` - Returns an array of differences as `Difference` objects.
+
+## TextUtil
+* `getMatchingParts(string, stringToFind)` - 
+Returns a Match object. The Match object for `getMatchingParts('Chicken', 'ck')` 
+looks like this `{start: 'Chi', match: 'ck', end: 'en'}`.
+* `getIndexOf(sourceString, targetString)` - Is basically `sourceString.toLowerCase().indexOf(targetString.toLowerCase)`
+* `contains(sourceString, targetString)` - Checks if a string exists within another. This is case-insensitive.
+* `isLowerCase(string)` - Checks if a string is upper or lowercase.

src/utils/object.util.ts

@@ -51,13 +51,13 @@ import {EmptyUtil} from "./empty.util";
 
-    private static cloneField(object: any, key: string, obj: any) {
+    private static cloneField(object: any, key: string, targetObject: any) {
         if (ArrayUtil.isArray(object[key])) {
-            obj[key] = ArrayUtil.clone(object[key]);
+            targetObject[key] = ArrayUtil.clone(object[key]);
         } else if (ObjectUtil.isObject(object[key])) {
-            obj[key] = ObjectUtil.clone(object[key]);
+            targetObject[key] = ObjectUtil.clone(object[key]);
         } else {
-            obj[key] = object[key];
+            targetObject[key] = object[key];
         }
     }
 
-    public static isEqual(object1: Object, object2: Object): boolean {
+    public static isEqual(object1: object, object2: object): boolean {
         return ObjectUtil.getDifference(object1, object2).length === 0;
@@ -64,0 +64,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

65627

increased by2.29%

Number of downloads

15

increased by7.14%

Number of lines in readme file

25

increased by400%

No dependency changes