@bigbinary/neeto-commons-frontend 2.0.99 → 2.0.101

package/pure.d.ts

@@ -14,7 +14,7 @@ type MatchPattern<Obj = any, Parent = Obj> = Obj extends any[] ? Matchable<Obj,
  *
  * Failsafe status: alternative available
  *
- * Converts camelCase to snake_case.
+ * Converts camelCase string to snake_case.
  *
  * @example 
  *
@@ -50,24 +50,6 @@ export function _capitalize(string: NilOr<string>): NilOr<string>;
  *
  * keys in the resulting array.
  *
- * A function that accepts an input array and returns a new array with elements
- *
- * such that: each element will contain the newly specified keys with its value
- *
- * same as the value of specified source keys.
- *
- * Usage:
- *
- * @example 
- *
- * copyKeys({
- *   sourceKey1: "destinationKey1",
- *   sourceKey2: "destinationKey2",
- *   ...
- * }, arrayOfObjects);
- * @endexample
- * Example:
- *
  * @example 
  *
  * const data = [
@@ -99,24 +81,6 @@ export function copyKeys<T>(keyMap: { [key in keyof Partial<T>]: string }, objec
  *
  * keys in the resulting array.
  *
- * A function that accepts an input array and returns a new array with elements
- *
- * such that: each element will contain the newly specified keys with its value
- *
- * same as the value of specified source keys.
- *
- * Usage:
- *
- * @example 
- *
- * copyKeys({
- *   sourceKey1: "destinationKey1",
- *   sourceKey2: "destinationKey2",
- *   ...
- * }, arrayOfObjects);
- * @endexample
- * Example:
- *
  * @example 
  *
  * const data = [
@@ -158,29 +122,6 @@ export function _copyKeys(keyMap: {
  *
  * has a different structure for the key mapping to support nesting.
  *
- * They key mapping object is completely different from the one used in copyKeys
- *
- * to support object nesting. It accepts destination as key and source as value.
- *
- * Source can be of three types
- *
- * Usage:
- *
- * @example 
- *
- * copyKeysDeep({
- *   destinationKey: "sourceKey",
- *   {
- *     destinationKey: "sourceKeyInNestedObject",
- *   },
- *   {
- *     destinationKey2: ["path", "to", "sourceKeyInNestedObject"],
- *     destinationKey3: (value, root) => value + root.id,
- *   }
- * }, arrayOfObjects);
- * @endexample
- * Example:
- *
  * @example 
  *
  * const data = [
@@ -201,7 +142,7 @@ export function _copyKeys(keyMap: {
  * ];
  * 
  * // reformatting `data` to label-and-value format for neetoui-select.
- * copyKeys(
+ * copyKeysDeep(
  *   {
  *     name: "label",
  *     quantity: (qty, root) => qty + root.user.bonusQty,
@@ -243,29 +184,6 @@ export function copyKeysDeep(keyMap: object, objectArray: object[]): object[];
  *
  * has a different structure for the key mapping to support nesting.
  *
- * They key mapping object is completely different from the one used in copyKeys
- *
- * to support object nesting. It accepts destination as key and source as value.
- *
- * Source can be of three types
- *
- * Usage:
- *
- * @example 
- *
- * copyKeysDeep({
- *   destinationKey: "sourceKey",
- *   {
- *     destinationKey: "sourceKeyInNestedObject",
- *   },
- *   {
- *     destinationKey2: ["path", "to", "sourceKeyInNestedObject"],
- *     destinationKey3: (value, root) => value + root.id,
- *   }
- * }, arrayOfObjects);
- * @endexample
- * Example:
- *
  * @example 
  *
  * const data = [
@@ -286,7 +204,7 @@ export function copyKeysDeep(keyMap: object, objectArray: object[]): object[];
  * ];
  * 
  * // reformatting `data` to label-and-value format for neetoui-select.
- * copyKeys(
+ * copyKeysDeep(
  *   {
  *     name: "label",
  *     quantity: (qty, root) => qty + root.user.bonusQty,
@@ -328,8 +246,6 @@ export function _copyKeysDeep(keyMap: object): (objectArray: NilOr<object[]>) =>
  *
  * Counts an array of items for items that matches the given pattern.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -353,8 +269,6 @@ export function countBy<T>(pattern: MatchPattern<T>, entityArray: T[]): number;
  *
  * Counts an array of items for items that matches the given pattern.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -378,11 +292,7 @@ export function _countBy(pattern: MatchPattern): (entityArray: NilOr<object[]>)
  *
  * Failsafe status: failsafe by default
  *
- * To make an object immutable, recursively freeze each property which is of type
- *
- * object.
- *
- * Usage:
+ * To make an object immutable, recursively freeze each property which is of type object.
  *
  * @example 
  *
@@ -404,9 +314,7 @@ 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 
  *
@@ -434,8 +342,6 @@ export function deepFreezeObject<T>(object: T): Readonly<T>;
  *
  * corresponding to that index.
  *
- * Usage:
- *
  * @example 
  *
  * dynamicArray(3, index => `option ${index + 1}`);
@@ -454,8 +360,6 @@ export function dynamicArray<T>(count: number, elementGenerator: (index: number)
  *
  * found, false otherwise.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -478,8 +382,6 @@ export function existsBy<T>(pattern: MatchPattern<T>, entityArray: T[]): boolean
  *
  * found, false otherwise.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -502,8 +404,6 @@ export function _existsBy(pattern: MatchPattern): (entityArray: NilOr<object[]>)
  *
  * Search for an item in the given array using the given id.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -524,8 +424,6 @@ export function existsById(id: any, entityArray: object[]): boolean;
  *
  * Search for an item in the given array using the given id.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -548,8 +446,6 @@ export function _existsById(id: any): (entityArray: NilOr<object[]>) => NilOr<bo
  *
  * Filter an array of items based on pattern matching.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -573,8 +469,6 @@ export function filterBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
  *
  * Filter an array of items based on pattern matching.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -628,8 +522,6 @@ export function _filterNonNull(object: NilOr<object>): NilOr<object>;
  *
  * Find the first item that matches the given pattern from an array.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -651,8 +543,6 @@ export function findBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T;
  *
  * Find the first item that matches the given pattern from an array.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -676,8 +566,6 @@ export function _findBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) =>
  *
  * Find an object having the given id from an array.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -699,8 +587,6 @@ export function findById<T>(id: any, entityArray: T[]): T;
  *
  * Find an object having the given id from an array.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -724,8 +610,6 @@ export function _findById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T>;
  *
  * Find the index of an item that matches the pattern from the given array.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -747,8 +631,6 @@ export function findIndexBy<T>(pattern: MatchPattern<T>, entityArray: T[]): numb
  *
  * Find the index of an item that matches the pattern from the given array.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -774,8 +656,6 @@ export function _findIndexBy(pattern: MatchPattern): (entityArray: NilOr<object[
  *
  * entities inside it.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -799,8 +679,6 @@ export function findIndexById(id: any, entityArray: object[]): number;
  *
  * entities inside it.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -824,8 +702,6 @@ export function _findIndexById(id: any): (entityArray: NilOr<object[]>) => NilOr
  *
  * Find the last item that matches the given pattern.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -848,8 +724,6 @@ export function findLastBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T;
  *
  * Find the last item that matches the given pattern.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -874,8 +748,6 @@ export function _findLastBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>)
  *
  * Find the last index of item that matches the given pattern.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -898,8 +770,6 @@ export function findLastIndexBy(id: any, entityArray: object[]): number;
  *
  * Find the last index of item that matches the given pattern.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -922,9 +792,7 @@ export function _findLastIndexBy(id: any): (entityArray: NilOr<object[]>) => Nil
  *
  * Failsafe status: not failsafe
  *
- * This function is used to generate a random integer.
- *
- * Here are some sample usages:
+ * 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.
  *
  * @example 
  *
@@ -966,6 +834,12 @@ export function isNot(a: any): (b: any) => boolean;
  *
  * objects). False otherwise. (the opposite of isEmpty in ramda)
  *
+ * @example 
+ *
+ * isNotEmpty(""); // returns false
+ * isNotEmpty(["a"]); // returns true
+ * isNotEMpty({ name: "Oliver" }); //return true
+ * @endexample
 */
 export const isNotEmpty: (a: any) => boolean;
 export function isNotEqualDeep(a: any, b: any): boolean;
@@ -978,8 +852,6 @@ export function isNotEqualDeep(a: any): (b: any) => boolean;
  *
  * Recursively converts the snake cased object keys to camel case
  *
- * Usage:
- *
  * @example 
  *
  * keysToCamelCase({
@@ -1005,8 +877,6 @@ export function keysToCamelCase(object: any): any;
  *
  * Recursively converts the camel cased object keys to snake case.
  *
- * Usage:
- *
  * @example 
  *
  * keysToSnakeCase({
@@ -1030,33 +900,7 @@ export function keysToSnakeCase(object: any): any;
  *
  * Failsafe status: failsafe by default
  *
- * 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) for a match.
- *
- * This function accepts two objects (pattern and data) as parameters and returns
- *
- * true if all the keys in pattern exist in data and the primitive values of those
- *
- * keys are identical to the data. Object values are compared recursively for inner
- *
- * primitives.
- *
- * If a function is passed as pattern's property, and equality test is performed
- *
- * with corresponding object property. If equality fails, the function will be
- *
- * evaluated with the value of the corresponding property of the data. If function
- *
- * returns true, it will be considered as a match.
- *
- * In short, this function checks whether all the primitive keys in the pattern is
- *
- * equal to corresponding keys in the data and all conditions (functions) are
- *
- * satisfied.
+ * 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.
  *
  * @example 
  *
@@ -1087,33 +931,7 @@ export function matches<T>(pattern: MatchPattern<T>, data: T): boolean;
  *
  * Failsafe status: failsafe by default
  *
- * 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) for a match.
- *
- * This function accepts two objects (pattern and data) as parameters and returns
- *
- * true if all the keys in pattern exist in data and the primitive values of those
- *
- * keys are identical to the data. Object values are compared recursively for inner
- *
- * primitives.
- *
- * If a function is passed as pattern's property, and equality test is performed
- *
- * with corresponding object property. If equality fails, the function will be
- *
- * evaluated with the value of the corresponding property of the data. If function
- *
- * returns true, it will be considered as a match.
- *
- * In short, this function checks whether all the primitive keys in the pattern is
- *
- * equal to corresponding keys in the data and all conditions (functions) are
- *
- * satisfied.
+ * 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.
  *
  * @example 
  *
@@ -1148,8 +966,6 @@ export function matches(pattern: MatchPattern): (data: any) => boolean;
  *
  * argument to the function.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1175,8 +991,6 @@ export function modifyBy<T>(pattern: MatchPattern<T>, modifier: (previous: T) =>
  *
  * argument to the function.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1202,8 +1016,6 @@ export function modifyBy<T>(pattern: MatchPattern<T>, modifier: (previous: T) =>
  *
  * argument to the function.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1229,8 +1041,6 @@ export function modifyBy(pattern: MatchPattern): <T>(modifier: (previous: T) =>
  *
  * argument to the function.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1262,8 +1072,6 @@ export function _modifyBy(pattern: MatchPattern): <T>(modifier: (previous: T) =>
  *
  * of the match.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1292,8 +1100,6 @@ export function modifyById<T>(id: any, modifier: (previous: T) => T, entityArray
  *
  * of the match.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1322,8 +1128,6 @@ export function modifyById<T>(id: any, modifier: (previous: T) => T): (entityArr
  *
  * of the match.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1352,8 +1156,6 @@ export function modifyById(id: any): <T>(modifier: (previous: T) => T, entityArr
  *
  * of the match.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1398,8 +1200,6 @@ export function notEqualsDeep(a: any): (b: any) => boolean;
  *
  * element from the list of arguments.
  *
- * Usage:
- *
  * @example 
  *
  * randomPick("arg1", "arg2", "arg3", "arg4", "arg5");
@@ -1416,8 +1216,6 @@ export function randomPick<T>(...args: T[]): T;
  *
  * Remove all items that matches the given pattern from an array of items.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1439,8 +1237,6 @@ export function removeBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
  *
  * Remove all items that matches the given pattern from an array of items.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1464,8 +1260,6 @@ export function _removeBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>) =
  *
  * Return a new array with the item with the given id removed.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1487,8 +1281,6 @@ export function removeById<T>(id: any, entityArray: T[]): T[];
  *
  * Return a new array with the item with the given id removed.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1514,26 +1306,6 @@ export function _removeById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T[]>
  *
  * array. This creates a new instance and doesn't mutate the array.
  *
- * A function that accepts an input array and returns a new array with elements
- *
- * such that: each element will contain the newly specified keys with its value
- *
- * pointing to the value of specified source keys. The source keys will not be
- *
- * copied.
- *
- * Usage:
- *
- * @example 
- *
- * renameKeys({
- *   sourceKey1: "destinationKey1",
- *   sourceKey2: "destinationKey2",
- *   ...
- * }, arrayOfObjects);
- * @endexample
- * Example:
- *
  * @example 
  *
  * const data = [
@@ -1565,26 +1337,6 @@ export function renameKeys<T, M extends { [key in keyof Partial<T>]: string }>(k
  *
  * array. This creates a new instance and doesn't mutate the array.
  *
- * A function that accepts an input array and returns a new array with elements
- *
- * such that: each element will contain the newly specified keys with its value
- *
- * pointing to the value of specified source keys. The source keys will not be
- *
- * copied.
- *
- * Usage:
- *
- * @example 
- *
- * renameKeys({
- *   sourceKey1: "destinationKey1",
- *   sourceKey2: "destinationKey2",
- *   ...
- * }, arrayOfObjects);
- * @endexample
- * Example:
- *
  * @example 
  *
  * const data = [
@@ -1624,8 +1376,6 @@ export function _renameKeys<M extends {
  *
  * Replace all items that matches the given pattern with the given item.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1649,8 +1399,6 @@ export function replaceBy<T>(pattern: MatchPattern<T>, entityArray: T[]): T[];
  *
  * Replace all items that matches the given pattern with the given item.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1678,8 +1426,6 @@ export function _replaceBy(pattern: MatchPattern): <T>(entityArray: NilOr<T[]>)
  *
  * object.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1706,8 +1452,6 @@ export function replaceById<T>(id: any, entityArray: T[]): T[];
  *
  * object.
  *
- * Usage:
- *
  * @example 
  *
  * const array = [
@@ -1732,15 +1476,9 @@ export function _replaceById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T[]
  *
  * Failsafe status: failsafe by default
  *
- * Recursively converts the camel cased object keys to snake case. It will
- *
- * gracefully handle special objects like Date, dayjs instance etc.
- *
- * While converting, this function checks if the function named toJSON is present
+ * Recursively converts the camel cased object keys to snake case. It will gracefully handle special objects like Date, dayjs instance etc.
  *
- * in the value (if the value is an object) and if found, it calls the function and
- *
- * uses the return value for further processing.
+ * 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.
  *
  * Example 1:
  *
@@ -1778,13 +1516,7 @@ export function _replaceById(id: any): <T>(entityArray: NilOr<T[]>) => NilOr<T[]
  * }
  * 
  * @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;
@@ -1802,8 +1534,6 @@ export function serializeKeysToSnakeCase(object: object): object;
  *
  * This is helpful when serializing Date objects, dayjs objects etc.
  *
- * Usage:
- *
  * @example 
  *
  * preprocessForSerialization(dayjs("1980-01-01")); // returns "1980-01-01T00:00:00.000Z"
@@ -1838,7 +1568,7 @@ export function _slugify(string: NilOr<string>): NilOr<string>;
  *
  * Failsafe status: alternative available
  *
- * Converts snake_case to camelCase.
+ * Converts snake_case string to camelCase.
  *
  * @example 
  *
@@ -1857,8 +1587,6 @@ export function _snakeToCamelCase(string: NilOr<string>): NilOr<string>;
  *
  * "label" and "value".
  *
- * Usage:
- *
  * @example 
  *
  * toLabelAndValue("test");
@@ -1876,18 +1604,12 @@ export function toLabelAndValue(string: string): {
  *
  * Failsafe status: failsafe by default
  *
- * Passes each key and value of a the given object (recursively) to the given
+ * Passes each key and value of the given object (recursively) to the given
  *
  * transformer function. Reconstructs an object of the same hierarchy with the key
  *
  * value pair the transformer function returns.
  *
- * You can optionally pass an object transformer which will be executed on every
- *
- * value (including the supplied object itself) before any processing is done to
- *
- * it.
- *
  * Usage:
  *
  * @example