@bigbinary/neeto-commons-frontend 2.1.1 → 2.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.",
   "repository": "git@github.com:bigbinary/neeto-commons-frontend.git",
   "author": "Amaljith K <amaljith.k@bigbinary.com>",

package/pure.d.ts

@@ -1391,7 +1391,7 @@ export function _renameKeys<M extends {
  *  
  * @endexample
 */
-export function replaceBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
+export function replaceBy<T>(pattern: MatchPattern<T>, entity: T, entityArray: T[]): T[];
 /**
  *
  * Curried: true
@@ -1414,9 +1414,59 @@ export function replaceBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
  *  
  * @endexample
 */
-export function replaceBy(pattern: MatchPattern): <T>(entityArray: T[]) => T[];
-export function _replaceBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>): NilOr<T[]>;
-export function _replaceBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
+export function replaceBy<T>(pattern: MatchPattern<T>, entity: T): <T>(entityArray: T[]) => T[];
+/**
+ *
+ * Curried: true
+ *
+ * Failsafe status: alternative available
+ *
+ * Replace all items that matches the given pattern with the given item.
+ *
+ * @example 
+ *
+ * const array = [
+ *   { id: 1, name: "Sam", address: { street: "First street", pin: 101283 } },
+ *   { id: 2, name: "Oliver", address: { street: "Second street", pin: 998472 } },
+ * ];
+ * const newItem = { id: 2, name: "John" };
+ * 
+ * replaceBy({ name: "Oliver" }, newItem, array);
+ * 
+ * [{id: 1, name: "Sam"}, {id: 2, name: "John"}]
+ *  
+ * @endexample
+*/
+export function replaceBy(pattern: MatchPattern): <T>(entity: T) => (entityArray: T[]) => T[];
+export function _replaceBy<T>(pattern: MatchPattern<T>, entity: NilOr<T>, entityArray: NilOr<T[]>): NilOr<T[]>;
+export function _replaceBy<T>(pattern: MatchPattern<T>, entity: NilOr<T>): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
+export function _replaceBy(pattern: MatchPattern): <T>(entity: NilOr<T>) => <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
+/**
+ *
+ * Curried: true
+ *
+ * Failsafe status: alternative available
+ *
+ * Returns a new array with the item having the given id is replaced with the given
+ *
+ * object.
+ *
+ * @example 
+ *
+ * const array = [
+ *   { id: 1, name: "Sam" },
+ *   { id: 2, name: "Oliver" },
+ * ];
+ * const idOfItemToBeReplaced = 2;
+ * const newItem = { id: 3, name: "John" };
+ * 
+ * replaceById(idOfItemToBeReplaced, newItem, array);
+ * 
+ * [{ id: 1, name: "Sam" }, { id: 3, name: "John" }]
+ * 
+ * @endexample
+*/
+export function replaceById<T>(id: any, entity: T, entityArray: T[]): T[];
 /**
  *
  * Curried: true
@@ -1442,7 +1492,7 @@ export function _replaceBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>)
  * 
  * @endexample
 */
-export function replaceById<T>(id: any, entityArray: T[]): T[];
+export function replaceById<T>(id: any, entity: T): <T>(entityArray: T[]) => T[];
 /**
  *
  * Curried: true
@@ -1468,9 +1518,10 @@ export function replaceById<T>(id: any, entityArray: T[]): T[];
  * 
  * @endexample
 */
-export function replaceById(id: any): <T>(entityArray: T[]) => T[];
-export function _replaceById<T>(id: any, entityArray: NilOr<T[]>): NilOr<T[]>;
-export function _replaceById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
+export function replaceById(id: any): <T>(entity: T) => <T>(entityArray: T[]) => T[];
+export function _replaceById<T>(id: any, entity: NilOr<T>, entityArray: NilOr<T[]>): NilOr<T[]>;
+export function _replaceById<T>(id: any, entity: NilOr<T>): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
+export function _replaceById(id: any): <T>(entity: NilOr<T>) => <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
  * Curried: false