@bigbinary/neeto-commons-frontend 2.1.6 → 2.1.7

package/pure.d.ts

@@ -11,11 +11,7 @@ type MatchPattern<Obj = any, Parent = Obj> = Obj extends any[] ? Matchable<Obj,
 });
 /**
  *
- * Curried: false
- *
- * Failsafe status: alternative available
- *
- * Converts camelCase string to snake_case.
+ * The camelToSnakeCase function converts a camelCase string to snake_case.
  *
  * @example 
  *
@@ -26,11 +22,7 @@ export function camelToSnakeCase(string: string): string;
 export function _camelToSnakeCase(string: NilOr<string>): NilOr<string>;
 /**
  *
- * Curried: false
- *
- * Failsafe status: alternative available
- *
- * Convert the first character of string to upper case.
+ * The capitalize function converts the first character of a string to uppercase.
  *
  * @example 
  *
@@ -43,13 +35,13 @@ export function capitalize(string: string): string;
 export function _capitalize(string: NilOr<string>): NilOr<string>;
 /**
  *
- * Curried: true
+ * The copyKeys function is similar to the renameKeys function
  *
- * Failsafe status: alternative available
+ * but retains both the source and destination keys in the resulting array. For
  *
- * Similar to renameKeys function, but it keeps both the source and destination
+ * deep copying of nested objects refer to copyKeysDeep
  *
- * keys in the resulting array.
+ * function.
  *
  * @example 
  *
@@ -74,13 +66,13 @@ export function copyKeys<T>(keyMap: { [key in keyof Partial<T>]: string }, objec
 })[];
 /**
  *
- * Curried: true
+ * The copyKeys function is similar to the renameKeys function
  *
- * Failsafe status: alternative available
+ * but retains both the source and destination keys in the resulting array. For
  *
- * Similar to renameKeys function, but it keeps both the source and destination
+ * deep copying of nested objects refer to copyKeysDeep
  *
- * keys in the resulting array.
+ * function.
  *
  * @example 
  *
@@ -115,13 +107,11 @@ export function _copyKeys(keyMap: {
 })[]>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The copyKeysDeep function is an advanced version of the
  *
- * A more advanced version of copyKeys function. It supports nested objects. It
+ * copyKeys function. It supports deep copying with nested objects
  *
- * has a different structure for the key mapping to support nesting.
+ * and offers flexibility in specifying key mappings for the copy operation.
  *
  * @example 
  *
@@ -142,7 +132,7 @@ export function _copyKeys(keyMap: {
  *   },
  * ];
  * 
- * // reformatting `data` to label-and-value format for neetoui-select.
+ * // Create a new array to hold the transformed objects
  * copyKeysDeep(
  *   {
  *     name: "label",
@@ -177,13 +167,11 @@ export function _copyKeys(keyMap: {
 export function copyKeysDeep(keyMap: object, objectArray: object[]): object[];
 /**
  *
- * Curried: true
+ * The copyKeysDeep function is an advanced version of the
  *
- * Failsafe status: alternative available
+ * copyKeys function. It supports deep copying with nested objects
  *
- * A more advanced version of copyKeys function. It supports nested objects. It
- *
- * has a different structure for the key mapping to support nesting.
+ * and offers flexibility in specifying key mappings for the copy operation.
  *
  * @example 
  *
@@ -204,7 +192,7 @@ export function copyKeysDeep(keyMap: object, objectArray: object[]): object[];
  *   },
  * ];
  * 
- * // reformatting `data` to label-and-value format for neetoui-select.
+ * // Create a new array to hold the transformed objects
  * copyKeysDeep(
  *   {
  *     name: "label",
@@ -241,11 +229,9 @@ export function _copyKeysDeep(keyMap: object, objectArray: NilOr<object[]>): Nil
 export function _copyKeysDeep(keyMap: object): (objectArray: NilOr<object[]>) => NilOr<object[]>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The countBy function counts the number of items in an array that match the
  *
- * Counts an array of items for items that matches the given pattern.
+ * provided pattern.
  *
  * @example 
  *
@@ -264,11 +250,9 @@ export function _copyKeysDeep(keyMap: object): (objectArray: NilOr<object[]>) =>
 export function countBy<T>(pattern: MatchPattern<T>, entityArray: T[]): number;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The countBy function counts the number of items in an array that match the
  *
- * Counts an array of items for items that matches the given pattern.
+ * provided pattern.
  *
  * @example 
  *
@@ -289,11 +273,11 @@ export function _countBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>):
 export function _countBy(pattern: MatchPattern): (entityArray: NilOr<object[]>) => NilOr<number>;
 /**
  *
- * Curried: false
+ * The deepFreezeObject function is used to make an object immutable by
  *
- * Failsafe status: failsafe by default
+ * recursively freezing each property that is of type object. Freezing an object
  *
- * To make an object immutable, recursively freeze each property which is of type object.
+ * prevents any changes to its properties, making it effectively immutable.
  *
  * @example 
  *
@@ -315,7 +299,9 @@ export function _countBy(pattern: MatchPattern): (entityArray: NilOr<object[]>)
  * };
  * 
  * @endexample
- * The assignment operation will throw the error only when we execute it in strict mode, in non-strict mode it will fail silently.
+ * The assignment operation will throw the error only when we execute it in strict
+ *
+ * mode, in non-strict mode it will fail silently.
  *
  * @example 
  *
@@ -333,15 +319,15 @@ export function _countBy(pattern: MatchPattern): (entityArray: NilOr<object[]>)
 export function deepFreezeObject<T>(object: T): Readonly<T>;
 /**
  *
- * Curried: false
+ * The dynamicArray function constructs an array of a specified length using a
  *
- * Failsafe status: not failsafe
+ * provided function to generate each element. The function takes the index as a
  *
- * Builds an array of given length using a given function to generate each element.
+ * parameter and is expected to return the element corresponding to that index.
  *
- * The function will get index as parameter and is expected to return the element
+ * This function does not include a failsafe mechanism, so it is important to
  *
- * corresponding to that index.
+ * ensure that the provided function and length are valid to prevent errors.
  *
  * @example 
  *
@@ -353,13 +339,9 @@ export function deepFreezeObject<T>(object: T): Readonly<T>;
 export function dynamicArray<T>(count: number, elementGenerator: (index: number) => T): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The existsBy function searches for an item in the array that matches the
  *
- * Search for an item that matches the given pattern in an array. Returns true if
- *
- * found, false otherwise.
+ * provided pattern and returns true if found, or false otherwise.
  *
  * @example 
  *
@@ -375,13 +357,9 @@ export function dynamicArray<T>(count: number, elementGenerator: (index: number)
 export function existsBy<T>(pattern: MatchPattern<T>, entityArray: T[]): boolean;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Search for an item that matches the given pattern in an array. Returns true if
+ * The existsBy function searches for an item in the array that matches the
  *
- * found, false otherwise.
+ * provided pattern and returns true if found, or false otherwise.
  *
  * @example 
  *
@@ -399,11 +377,9 @@ export function _existsBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>):
 export function _existsBy(pattern: MatchPattern): (entityArray: NilOr<object[]>) => NilOr<boolean>;
 /**
  *
- * Curried: true
+ * The existsById function searches for an item in the provided array using the
  *
- * Failsafe status: alternative available
- *
- * Search for an item in the given array using the given id.
+ * given id.
  *
  * @example 
  *
@@ -419,11 +395,9 @@ export function _existsBy(pattern: MatchPattern): (entityArray: NilOr<object[]>)
 export function existsById(id: any, entityArray: object[]): boolean;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The existsById function searches for an item in the provided array using the
  *
- * Search for an item in the given array using the given id.
+ * given id.
  *
  * @example 
  *
@@ -441,11 +415,7 @@ export function _existsById(id: any, entityArray: NilOr<object[]>): NilOr<boolea
 export function _existsById(id: any): (entityArray: NilOr<object[]>) => NilOr<boolean>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Filter an array of items based on pattern matching.
+ * The filterBy function filters an array of items based on pattern matching.
  *
  * @example 
  *
@@ -464,11 +434,7 @@ export function _existsById(id: any): (entityArray: NilOr<object[]>) => NilOr<bo
 export function filterBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Filter an array of items based on pattern matching.
+ * The filterBy function filters an array of items based on pattern matching.
  *
  * @example 
  *
@@ -489,13 +455,13 @@ export function _filterBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>):
 export function _filterBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
- * Curried: false
+ * The filterNonNull function accepts an object and returns a new object with
  *
- * Failsafe status: alternative available
+ * only the properties that are not null or undefined. It filters out
  *
- * A function that accepts an object and returns a new object with only the
+ * properties with these values, creating a new object with only the non-null and
  *
- * properties that are not null or undefined. This won't work well for arrays.
+ * non-undefined properties.
  *
  * @example 
  *
@@ -517,11 +483,9 @@ export function filterNonNull(object: object): object;
 export function _filterNonNull(object: NilOr<object>): NilOr<object>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findBy function locates the first item in the array that matches the
  *
- * Find the first item that matches the given pattern from an array.
+ * provided pattern.
  *
  * @example 
  *
@@ -538,11 +502,9 @@ export function _filterNonNull(object: NilOr<object>): NilOr<object>;
 export function findBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T;
 /**
  *
- * Curried: true
+ * The findBy function locates the first item in the array that matches the
  *
- * Failsafe status: alternative available
- *
- * Find the first item that matches the given pattern from an array.
+ * provided pattern.
  *
  * @example 
  *
@@ -561,11 +523,9 @@ export function _findBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>): N
 export function _findBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) => NilOr<T>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findById function is used to locate an object within an array based on the
  *
- * Find an object having the given id from an array.
+ * provided Id.
  *
  * @example 
  *
@@ -582,11 +542,9 @@ export function _findBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) =>
 export function findById<T>(id: any, entityArray: T[]): T;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findById function is used to locate an object within an array based on the
  *
- * Find an object having the given id from an array.
+ * provided Id.
  *
  * @example 
  *
@@ -605,11 +563,9 @@ export function _findById<T>(id: any, entityArray: NilOr<T[]>): NilOr<T>;
 export function _findById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T>;
 /**
  *
- * Curried: true
+ * The findIndexBy function finds the index of the item in the array that matches
  *
- * Failsafe status: alternative available
- *
- * Find the index of an item that matches the pattern from the given array.
+ * the provided pattern.
  *
  * @example 
  *
@@ -626,11 +582,9 @@ export function _findById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T>;
 export function findIndexBy<T>(pattern: MatchPattern<T>, entityArray: T[]): number;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findIndexBy function finds the index of the item in the array that matches
  *
- * Find the index of an item that matches the pattern from the given array.
+ * the provided pattern.
  *
  * @example 
  *
@@ -649,13 +603,9 @@ export function _findIndexBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]
 export function _findIndexBy(pattern: MatchPattern): (entityArray: NilOr<object[]>) => NilOr<number>;
 /**
  *
- * Curried: true
+ * The findIndexById function is used to find the index of an item within an
  *
- * Failsafe status: alternative available
- *
- * Find an index of an item from an array of items based on the id property of
- *
- * entities inside it.
+ * array of items based on the id property of the entities within it.
  *
  * @example 
  *
@@ -672,13 +622,9 @@ export function _findIndexBy(pattern: MatchPattern): (entityArray: NilOr<object[
 export function findIndexById(id: any, entityArray: object[]): number;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findIndexById function is used to find the index of an item within an
  *
- * Find an index of an item from an array of items based on the id property of
- *
- * entities inside it.
+ * array of items based on the id property of the entities within it.
  *
  * @example 
  *
@@ -697,11 +643,9 @@ export function _findIndexById(id: any, entityArray: NilOr<object[]>): NilOr<num
 export function _findIndexById(id: any): (entityArray: NilOr<object[]>) => NilOr<number>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findLastBy function finds the last item in the array that matches the
  *
- * Find the last item that matches the given pattern.
+ * provided pattern.
  *
  * @example 
  *
@@ -719,11 +663,9 @@ export function _findIndexById(id: any): (entityArray: NilOr<object[]>) => NilOr
 export function findLastBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T;
 /**
  *
- * Curried: true
+ * The findLastBy function finds the last item in the array that matches the
  *
- * Failsafe status: alternative available
- *
- * Find the last item that matches the given pattern.
+ * provided pattern.
  *
  * @example 
  *
@@ -743,11 +685,9 @@ export function _findLastBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>
 export function _findLastBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) => NilOr<T>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findLastIndexBy function finds the last index of an item in the array that
  *
- * Find the last index of item that matches the given pattern.
+ * matches the provided pattern.
  *
  * @example 
  *
@@ -765,11 +705,9 @@ export function _findLastBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>)
 export function findLastIndexBy(id: any, entityArray: object[]): number;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The findLastIndexBy function finds the last index of an item in the array that
  *
- * Find the last index of item that matches the given pattern.
+ * matches the provided pattern.
  *
  * @example 
  *
@@ -789,11 +727,11 @@ export function _findLastIndexBy(id: any, entityArray: NilOr<object[]>): NilOr<n
 export function _findLastIndexBy(id: any): (entityArray: NilOr<object[]>) => NilOr<number>;
 /**
  *
- * Curried: false
+ * The getRandomInt function generates a random integer within a specified range.
  *
- * Failsafe status: not failsafe
+ * If only one argument is provided, it is considered as the upper bound, and the
  *
- * This function is used to generate a random integer in the given range. If only 1 argument is provided, it is considered as the upper bound.
+ * lower bound is assumed to be 0.
  *
  * @example 
  *
@@ -805,13 +743,9 @@ export function _findLastIndexBy(id: any): (entityArray: NilOr<object[]>) => Nil
 export function getRandomInt(a?: number, b?: number): number;
 /**
  *
- * Curried: false
- *
- * Failsafe status: alternative available
- *
- * Converts common developer friendly string formats (camelCase, snake_case,
+ * The humanize function converts common developer-friendly string formats such
  *
- * dash-case etc) to human readable string.
+ * as camelCase, snake_case, dash-case, etc., into human-readable strings.
  *
  * @example 
  *
@@ -823,35 +757,137 @@ export function getRandomInt(a?: number, b?: number): number;
 */
 export function humanize(string: string): string;
 export function _humanize(string: NilOr<string>): NilOr<string>;
+/**
+ *
+ * The isNot function returns true if the given values (or references) are not
+ *
+ * equal and false otherwise. It provides the opposite behavior of the
+ *
+ * Object.is() method.
+ *
+ * The primary difference between isNot() and !== is that isNot() is a
+ *
+ * curried function, which means you can partially apply it to create a new
+ *
+ * function that's pre-configured to compare one value against another value
+ *
+ * repeatedly.
+ *
+ * @example 
+ *
+ * const value1 = 10;
+ * const isNotValue1 = isNot(value1);
+ * const value2 = 20;
+ * isNotValue1(value2); // true
+ * 
+ * // Filter out fruits that are not Apple
+ * const fruits = ["Apple", "Orange", "Lemon"];
+ * fruits.filter(notEquals("Apple")); // ["Orange", "Lemon"];
+ * @endexample
+*/
 export function isNot(a: any, b: any): boolean;
+/**
+ *
+ * The isNot function returns true if the given values (or references) are not
+ *
+ * equal and false otherwise. It provides the opposite behavior of the
+ *
+ * Object.is() method.
+ *
+ * The primary difference between isNot() and !== is that isNot() is a
+ *
+ * curried function, which means you can partially apply it to create a new
+ *
+ * function that's pre-configured to compare one value against another value
+ *
+ * repeatedly.
+ *
+ * @example 
+ *
+ * const value1 = 10;
+ * const isNotValue1 = isNot(value1);
+ * const value2 = 20;
+ * isNotValue1(value2); // true
+ * 
+ * // Filter out fruits that are not Apple
+ * const fruits = ["Apple", "Orange", "Lemon"];
+ * fruits.filter(notEquals("Apple")); // ["Orange", "Lemon"];
+ * @endexample
+*/
 export function isNot(a: any): (b: any) => boolean;
 /**
  *
- * Curried: false
+ * The isNotEmpty returns true if the given value is not empty (includes
  *
- * Failsafe status: failsafe by default
+ * strings, arrays, objects) and false otherwise. It provides the opposite
  *
- * Returns true if the given value is not empty (includes strings, arrays,
+ * behavior of checking if a value is empty, similar to the isEmpty function in
  *
- * objects). False otherwise. (the opposite of isEmpty in ramda)
+ * Ramda.
  *
  * @example 
  *
  * isNotEmpty(""); // returns false
  * isNotEmpty(["a"]); // returns true
- * isNotEMpty({ name: "Oliver" }); //return true
+ * isNotEmpty({ name: "Oliver" }); //return true
  * @endexample
 */
 export const isNotEmpty: (a: any) => boolean;
+/**
+ *
+ * The isNotEqualDeep function returns true if the given values are not equal,
+ *
+ * considering deep equality. It checks for deep inequality between objects or
+ *
+ * arrays.
+ *
+ * @example 
+ *
+ * const object1 = {
+ *   a: 1,
+ *   b: { c: 3 },
+ * };
+ * 
+ * const object2 = {
+ *   a: 1,
+ *   b: { c: 2 },
+ * };
+ * 
+ * isNotEqualsDeep(object1, object2); //returns true
+ * notEqualsDeep(object1, object2); //returns true
+ * @endexample
+*/
 export function isNotEqualDeep(a: any, b: any): boolean;
-export function isNotEqualDeep(a: any): (b: any) => boolean;
 /**
  *
- * Curried: false
+ * The isNotEqualDeep function returns true if the given values are not equal,
  *
- * Failsafe status: failsafe by default
+ * considering deep equality. It checks for deep inequality between objects or
  *
- * Recursively converts the snake cased object keys to camel case
+ * arrays.
+ *
+ * @example 
+ *
+ * const object1 = {
+ *   a: 1,
+ *   b: { c: 3 },
+ * };
+ * 
+ * const object2 = {
+ *   a: 1,
+ *   b: { c: 2 },
+ * };
+ * 
+ * isNotEqualsDeep(object1, object2); //returns true
+ * notEqualsDeep(object1, object2); //returns true
+ * @endexample
+*/
+export function isNotEqualDeep(a: any): (b: any) => boolean;
+/**
+ *
+ * The keysToCamelCase function recursively converts the snake-cased object keys
+ *
+ * to camel case.
  *
  * @example 
  *
@@ -872,11 +908,9 @@ export function isNotEqualDeep(a: any): (b: any) => boolean;
 export function keysToCamelCase(object: any): any;
 /**
  *
- * Curried: false
+ * The keysToSnakeCase function recursively converts the camel-cased object keys
  *
- * Failsafe status: failsafe by default
- *
- * Recursively converts the camel cased object keys to snake case.
+ * to snake case.
  *
  * @example 
  *
@@ -897,11 +931,13 @@ export function keysToCamelCase(object: any): any;
 export function keysToSnakeCase(object: any): any;
 /**
  *
- * Curried: true
+ * The matches function checks whether the given object matches the given
+ *
+ * pattern. It compares the primitive value (int, boolean, string, etc.) in the
  *
- * Failsafe status: failsafe by default
+ * object with the corresponding values in the pattern (deeply) and checks if all
  *
- * Checks whether the given object matches the given pattern. Each primitive value (int, boolean, string, etc.) in the pattern should be same as the corresponding value in the object (deeply) and all conditions (functions) should be satisfied for a match.
+ * conditions (functions) are satisfied for a match.
  *
  * @example 
  *
@@ -928,11 +964,13 @@ export function keysToSnakeCase(object: any): any;
 export function matches<T>(pattern: MatchPattern<T>, data: T): boolean;
 /**
  *
- * Curried: true
+ * The matches function checks whether the given object matches the given
  *
- * Failsafe status: failsafe by default
+ * pattern. It compares the primitive value (int, boolean, string, etc.) in the
  *
- * Checks whether the given object matches the given pattern. Each primitive value (int, boolean, string, etc.) in the pattern should be same as the corresponding value in the object (deeply) and all conditions (functions) should be satisfied for a match.
+ * object with the corresponding values in the pattern (deeply) and checks if all
+ *
+ * conditions (functions) are satisfied for a match.
  *
  * @example 
  *
@@ -959,13 +997,9 @@ export function matches<T>(pattern: MatchPattern<T>, data: T): boolean;
 export function matches(pattern: MatchPattern): (data: any) => boolean;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Modify all items using modifier function based on a pattern passed as an
+ * The modifyBy function modifies all items in the array that match the provided
  *
- * argument to the function.
+ * pattern using the given modifier function.
  *
  * @example 
  *
@@ -984,13 +1018,9 @@ export function matches(pattern: MatchPattern): (data: any) => boolean;
 export function modifyBy<T>(pattern: MatchPattern<T>, modifier: (previous: T) => T, entityArray: T[]): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Modify all items using modifier function based on a pattern passed as an
+ * The modifyBy function modifies all items in the array that match the provided
  *
- * argument to the function.
+ * pattern using the given modifier function.
  *
  * @example 
  *
@@ -1009,13 +1039,9 @@ export function modifyBy<T>(pattern: MatchPattern<T>, modifier: (previous: T) =>
 export function modifyBy<T>(pattern: MatchPattern<T>, modifier: (previous: T) => T): (entityArray: T[]) => T[];
 /**
  *
- * Curried: true
+ * The modifyBy function modifies all items in the array that match the provided
  *
- * Failsafe status: alternative available
- *
- * Modify all items using modifier function based on a pattern passed as an
- *
- * argument to the function.
+ * pattern using the given modifier function.
  *
  * @example 
  *
@@ -1034,13 +1060,9 @@ export function modifyBy<T>(pattern: MatchPattern<T>, modifier: (previous: T) =>
 export function modifyBy(pattern: MatchPattern): <T>(modifier: (previous: T) => T, entityArray: T[]) => T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The modifyBy function modifies all items in the array that match the provided
  *
- * Modify all items using modifier function based on a pattern passed as an
- *
- * argument to the function.
+ * pattern using the given modifier function.
  *
  * @example 
  *
@@ -1063,15 +1085,11 @@ export function _modifyBy(pattern: MatchPattern): <T>(modifier: (previous: T) =>
 export function _modifyBy(pattern: MatchPattern): <T>(modifier: (previous: T) => T) => (entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The modifyById function applies a modifier function to the item with the
  *
- * Applies the modifier function on the item having the given id in an array and
+ * specified id in an array and returns a new array with the modified item in the
  *
- * returns a new array with the return value of the modifier function in the index
- *
- * of the match.
+ * same index.
  *
  * @example 
  *
@@ -1091,15 +1109,11 @@ export function _modifyBy(pattern: MatchPattern): <T>(modifier: (previous: T) =>
 export function modifyById<T>(id: any, modifier: (previous: T) => T, entityArray: T[]): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Applies the modifier function on the item having the given id in an array and
+ * The modifyById function applies a modifier function to the item with the
  *
- * returns a new array with the return value of the modifier function in the index
+ * specified id in an array and returns a new array with the modified item in the
  *
- * of the match.
+ * same index.
  *
  * @example 
  *
@@ -1119,15 +1133,11 @@ export function modifyById<T>(id: any, modifier: (previous: T) => T, entityArray
 export function modifyById<T>(id: any, modifier: (previous: T) => T): (entityArray: T[]) => T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
- *
- * Applies the modifier function on the item having the given id in an array and
+ * The modifyById function applies a modifier function to the item with the
  *
- * returns a new array with the return value of the modifier function in the index
+ * specified id in an array and returns a new array with the modified item in the
  *
- * of the match.
+ * same index.
  *
  * @example 
  *
@@ -1147,15 +1157,11 @@ export function modifyById<T>(id: any, modifier: (previous: T) => T): (entityArr
 export function modifyById(id: any): <T>(modifier: (previous: T) => T, entityArray: T[]) => T[];
 /**
  *
- * Curried: true
+ * The modifyById function applies a modifier function to the item with the
  *
- * Failsafe status: alternative available
+ * specified id in an array and returns a new array with the modified item in the
  *
- * Applies the modifier function on the item having the given id in an array and
- *
- * returns a new array with the return value of the modifier function in the index
- *
- * of the match.
+ * same index.
  *
  * @example 
  *
@@ -1179,11 +1185,11 @@ export function _modifyById(id: any): <T>(modifier: (previous: T) => T, entityAr
 export function _modifyById(id: any): <T>(modifier: (previous: T) => T) => (entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
- * Curried: false
+ * The noop function is a "no-operation" function that does nothing when called and
  *
- * Failsafe status: failsafe by default
+ * returns undefined. It is often used as a placeholder or a default function
  *
- * A "no-operation" function, which does nothing and returns nothing (undefined).
+ * when a function is expected but no action is required.
  *
 */
 export function noop(...args: any[]): void;
@@ -1193,13 +1199,11 @@ export function notEqualsDeep(a: any, b: any): boolean;
 export function notEqualsDeep(a: any): (b: any) => boolean;
 /**
  *
- * Curried: false
- *
- * Failsafe status: not failsafe
+ * The randomPick function accepts a variable number of arguments and returns a
  *
- * This function accepts a variable number of arguments and returns a random
+ * random element from the list of arguments. It randomly selects one of the
  *
- * element from the list of arguments.
+ * provided values and returns it.
  *
  * @example 
  *
@@ -1211,11 +1215,9 @@ export function notEqualsDeep(a: any): (b: any) => boolean;
 export function randomPick<T>(...args: T[]): T;
 /**
  *
- * Curried: true
+ * The removeBy function removes all items in the array that match the provided
  *
- * Failsafe status: alternative available
- *
- * Remove all items that matches the given pattern from an array of items.
+ * pattern.
  *
  * @example 
  *
@@ -1232,11 +1234,9 @@ export function randomPick<T>(...args: T[]): T;
 export function removeBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The removeBy function removes all items in the array that match the provided
  *
- * Remove all items that matches the given pattern from an array of items.
+ * pattern.
  *
  * @example 
  *
@@ -1255,11 +1255,9 @@ export function _removeBy<T>(pattern: MatchPattern<T>, entityArray: NilOr<T[]>):
 export function _removeBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
- * Curried: true
+ * The removeById function generates a new array with the item possessing the
  *
- * Failsafe status: alternative available
- *
- * Return a new array with the item with the given id removed.
+ * specified id removed.
  *
  * @example 
  *
@@ -1276,11 +1274,9 @@ export function _removeBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) =
 export function removeById<T>(id: any, entityArray: T[]): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The removeById function generates a new array with the item possessing the
  *
- * Return a new array with the item with the given id removed.
+ * specified id removed.
  *
  * @example 
  *
@@ -1299,13 +1295,11 @@ export function _removeById<T>(id: any, entityArray: NilOr<T[]>): NilOr<T[]>;
 export function _removeById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
- * Curried: true
+ * The renameKeys function renames specified keys in each object of an array
  *
- * Failsafe status: alternative available
+ * while keeping their values the same. It creates a new instance and does not
  *
- * Renames the specified keys keeping its value the same for all elements of an
- *
- * array. This creates a new instance and doesn't mutate the array.
+ * mutate the original array.
  *
  * @example 
  *
@@ -1330,13 +1324,11 @@ export function renameKeys<T, M extends { [key in keyof Partial<T>]: string }>(k
 })[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The renameKeys function renames specified keys in each object of an array
  *
- * Renames the specified keys keeping its value the same for all elements of an
+ * while keeping their values the same. It creates a new instance and does not
  *
- * array. This creates a new instance and doesn't mutate the array.
+ * mutate the original array.
  *
  * @example 
  *
@@ -1371,11 +1363,9 @@ export function _renameKeys<M extends {
 })[]>;
 /**
  *
- * Curried: true
+ * The replaceBy function replaces all items in the array that match the provided
  *
- * Failsafe status: alternative available
- *
- * Replace all items that matches the given pattern with the given item.
+ * pattern with the given item.
  *
  * @example 
  *
@@ -1394,11 +1384,9 @@ export function _renameKeys<M extends {
 export function replaceBy<T>(pattern: MatchPattern<T>, entity: T, entityArray: T[]): T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The replaceBy function replaces all items in the array that match the provided
  *
- * Replace all items that matches the given pattern with the given item.
+ * pattern with the given item.
  *
  * @example 
  *
@@ -1417,11 +1405,9 @@ export function replaceBy<T>(pattern: MatchPattern<T>, entity: T, entityArray: T
 export function replaceBy<T>(pattern: MatchPattern<T>, entity: T): <T>(entityArray: T[]) => T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The replaceBy function replaces all items in the array that match the provided
  *
- * Replace all items that matches the given pattern with the given item.
+ * pattern with the given item.
  *
  * @example 
  *
@@ -1443,13 +1429,9 @@ export function _replaceBy<T>(pattern: MatchPattern<T>, entity: NilOr<T>): <T>(e
 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
+ * The replaceById function returns a new array with the item having the
  *
- * object.
+ * specified id replaced by the provided object.
  *
  * @example 
  *
@@ -1469,13 +1451,9 @@ export function _replaceBy(pattern: MatchPattern): <T>(entity: NilOr<T>) => <T>(
 export function replaceById<T>(id: any, entity: T, entityArray: T[]): T[];
 /**
  *
- * Curried: true
+ * The replaceById function returns a new array with the item having the
  *
- * Failsafe status: alternative available
- *
- * Returns a new array with the item having the given id is replaced with the given
- *
- * object.
+ * specified id replaced by the provided object.
  *
  * @example 
  *
@@ -1495,13 +1473,9 @@ export function replaceById<T>(id: any, entity: T, entityArray: T[]): T[];
 export function replaceById<T>(id: any, entity: T): <T>(entityArray: T[]) => T[];
 /**
  *
- * Curried: true
- *
- * Failsafe status: alternative available
+ * The replaceById function returns a new array with the item having the
  *
- * Returns a new array with the item having the given id is replaced with the given
- *
- * object.
+ * specified id replaced by the provided object.
  *
  * @example 
  *
@@ -1524,13 +1498,17 @@ export function _replaceById<T>(id: any, entity: NilOr<T>): <T>(entityArray: Nil
 export function _replaceById(id: any): <T>(entity: NilOr<T>) => <T>(entityArray: NilOr<T[]>) => NilOr<T[]>;
 /**
  *
- * Curried: false
+ * The serializeKeysToSnakeCase function recursively converts the camel-cased
+ *
+ * object keys to snake case. It gracefully handles special objects like Date and
  *
- * Failsafe status: failsafe by default
+ * dayjs instances. Additionally, while converting, this function checks if the
  *
- * Recursively converts the camel cased object keys to snake case. It will gracefully handle special objects like Date, dayjs instance etc.
+ * value being processed is an object and if it has a toJSON function. If the
  *
- * While converting, this function checks if the function named toJSON is present in the value (if the value is an object) and if found, it calls the function and uses the return value for further processing.
+ * toJSON function is present, it calls the function and uses the return value
+ *
+ * for further processing.
  *
  * Example 1:
  *
@@ -1568,23 +1546,27 @@ export function _replaceById(id: any): <T>(entity: NilOr<T>) => <T>(entityArray:
  * }
  * 
  * @endexample
- * In the above example, the value of dob is an date object and has toJSON method present in it. The toJSON method returns the date in ISO format which will be used for further processing instead of recursively converting the original date object.
+ * In the above example, the value of dob is an date object and has toJSON
+ *
+ * method present in it. The toJSON method returns the date in ISO format which
+ *
+ * will be used for further processing instead of recursively converting the
+ *
+ * original date object.
  *
 */
 export function serializeKeysToSnakeCase(object: object): object;
 /**
  *
- * Curried: false
- *
- * Failsafe status: failsafe by default
+ * The preprocessForSerialization function creates a ready-to-be-serialized
  *
- * Creates a ready-to-be-serialized version of the given object by recursively
+ * version of the given object by recursively traversing all the object properties
  *
- * going to all the object properties and replacing it with its JSON serializable
+ * and replacing them with their JSON serializable versions. This is particularly
  *
- * version.
+ * helpful when serializing objects that include non-serializable data types, such
  *
- * This is helpful when serializing Date objects, dayjs objects etc.
+ * as Date objects, dayjs objects or custom classes.
  *
  * @example 
  *
@@ -1597,11 +1579,15 @@ export function serializeKeysToSnakeCase(object: object): object;
 export function preprocessForSerialization(object: object): object;
 /**
  *
- * Curried: false
+ * The slugify function converts a given string into a slug. A slug is a
  *
- * Failsafe status: alternative available
+ * URL-friendly representation of a string, typically used for creating
  *
- * Converts a given string to slug.
+ * human-readable and SEO-friendly URLs. This function transforms a string by
+ *
+ * removing spaces, special characters, and converting it to lowercase to create a
+ *
+ * valid slug.
  *
  * @example 
  *
@@ -1616,11 +1602,7 @@ export function slugify(string: string): string;
 export function _slugify(string: NilOr<string>): NilOr<string>;
 /**
  *
- * Curried: false
- *
- * Failsafe status: alternative available
- *
- * Converts snake_case string to camelCase.
+ * The snakeToCamelCase function converts a snake_case string to camelCase.
  *
  * @example 
  *
@@ -1631,13 +1613,11 @@ export function snakeToCamelCase(string: string): string;
 export function _snakeToCamelCase(string: NilOr<string>): NilOr<string>;
 /**
  *
- * Curried: false
+ * The toLabelAndValue function takes a string as an argument and returns an
  *
- * Failsafe status: failsafe by default
+ * object with keys "label" and "value." It is often used to transform a string
  *
- * This function takes a string as an argument and returns an object with keys
- *
- * "label" and "value".
+ * into an object with specific key-value pairs.
  *
  * @example 
  *
@@ -1652,15 +1632,13 @@ export function toLabelAndValue(string: string): {
 };
 /**
  *
- * Curried: false
- *
- * Failsafe status: failsafe by default
+ * The transformObjectDeep function passes each key and value of the given object
  *
- * Passes each key and value of the given object (recursively) to the given
+ * (recursively) to the provided transformer function. It reconstructs an object of
  *
- * transformer function. Reconstructs an object of the same hierarchy with the key
+ * the same hierarchy with the key-value pairs that the transformer function
  *
- * value pair the transformer function returns.
+ * returns.
  *
  * Usage:
  *
@@ -1699,11 +1677,9 @@ export function toLabelAndValue(string: string): {
 export function transformObjectDeep(object: object, keyValueTransformer: (key: string | number | symbol, object: any) => any[], objectPreProcessor?: (object: any) => any): object;
 /**
  *
- * Curried: false
- *
- * Failsafe status: alternative available
+ * The truncate function truncates a string by adding "..." if it exceeds a
  *
- * Truncate the string with ... if it is longer than specified string length.
+ * specified maximum length.
  *
  * @example 
  *
@@ -1714,11 +1690,9 @@ export function transformObjectDeep(object: object, keyValueTransformer: (key: s
 export function truncate(string: string, length: number): string;
 /**
  *
- * Curried: false
+ * The truncate function truncates a string by adding "..." if it exceeds a
  *
- * Failsafe status: alternative available
- *
- * Truncate the string with ... if it is longer than specified string length.
+ * specified maximum length.
  *
  * @example 
  *
@@ -1728,21 +1702,40 @@ export function truncate(string: string, length: number): string;
 */
 export function truncate(string: NilOr<string>, length: number): NilOr<string>;
 export function nullSafe<T extends Function>(func: T): (...args: any) => ReturnType<T>;
+/**
+ *
+ * The isNotPresent function is a utility that checks if a value is not present.
+ *
+ * It combines checks for null and empty values. It is worth noting that we also
+ *
+ * have a isPresent utility function that returns the complement of
+ *
+ * isNotPresent.
+ *
+*/
 export function isNotPresent(object: any): boolean;
 export function isPresent(object: any): boolean;
 /**
  *
- * Curried: true
+ * The modifyWithImmer function is designed for immutable modification of values
+ *
+ * and is an abstraction over Immer's produce method. Immer is a library that
+ *
+ * simplifies working with complex data structures and state updates in a more
+ *
+ * immutable manner.
+ *
+ * This function does not include a failsafe mechanism, so it is important to use
  *
- * Failsafe status: not failsafe
+ * it with care, especially when working with complex data structures.
  *
- * This function is used to modify values immutably. It is an abstraction over Immer's produce method. Immer becomes very useful when it comes to changing complex data. You can read more about Immer here.
+ * You can read more about Immer here.
  *
  * Returns the new modified value.
  *
  * @example 
  *
- * const data = { name: "Oliver" }
+ * const data = { name: "Oliver" };
  * modifyWithImmer(draft => {
  *   draft.name = "Oliver smith";
  * })(data);
@@ -1766,17 +1759,25 @@ export function isPresent(object: any): boolean;
 export function modifyWithImmer<T>(modifier: (draft: Draft<T>) => void, data: T): T;
 /**
  *
- * Curried: true
+ * The modifyWithImmer function is designed for immutable modification of values
+ *
+ * and is an abstraction over Immer's produce method. Immer is a library that
+ *
+ * simplifies working with complex data structures and state updates in a more
+ *
+ * immutable manner.
+ *
+ * This function does not include a failsafe mechanism, so it is important to use
  *
- * Failsafe status: not failsafe
+ * it with care, especially when working with complex data structures.
  *
- * This function is used to modify values immutably. It is an abstraction over Immer's produce method. Immer becomes very useful when it comes to changing complex data. You can read more about Immer here.
+ * You can read more about Immer here.
  *
  * Returns the new modified value.
  *
  * @example 
  *
- * const data = { name: "Oliver" }
+ * const data = { name: "Oliver" };
  * modifyWithImmer(draft => {
  *   draft.name = "Oliver smith";
  * })(data);