Variable ObjectUtils`Const`

ObjectUtils: {
    cloneObject<T>(obj): T;
    deepEqual(obj1, obj2): boolean;
    filterUniqueByProp<T>(objects, prop): T[];
    filterByKeys(obj, keys): Record<string, unknown>;
    findFirstNonZeroIndex(data): number;
    flatten(obj, prefix?): Record<string, unknown>;
    fromMap<T>(map): Record<string, T>;
    getNestedProp<T>(obj, ...path): null | T;
    groupByProp<T>(objects, ...propPath): Record<string, T[]>;
    hasNestedProp(obj, ...path): boolean;
    isEmpty(obj): boolean;
    isFunction(value): value is Function;
    isEqual(obj1, obj2): boolean;
    isEqualOnKeys(obj1, obj2, keys): boolean;
    isObject(value): value is Record<string, unknown>;
    mapByProp<T>(objects, ...propPath): Record<string, T>;
    matchesRules<T>(obj, ruleSet): boolean;
    merge<T>(...objects): T;
    omit<T>(obj, keys): Partial<T>;
    pick<T>(obj, keys): Partial<T>;
    removeNullishValues<T>(obj, noEmptyStrings?): Partial<T>;
    replaceEmptyStringsWithNull(obj, deep?): Record<string, unknown>;
    replaceKey<T>(obj, oldKey, newKey): Record<string, unknown>;
    replaceNullWithEmptyString(obj, fields?): Record<string, unknown>;
    setNestedProp<T>(obj, ...path): null | T;
    sortByProp<T>(__namedParameters): T[];
    toMap<T>(obj): Map<string, T>;
    transform<T>(obj, keyTransform?, valueTransform?): Record<string, unknown>;
} = ...

Type declaration

cloneObject:function
- cloneObject<T>(obj): T
- Creates a deep clone of an object, including nested objects and arrays.
  Type Parameters
  - T
    The type of the object to clone
  Parameters
  - obj: T
    The object to clone
  Returns T
  A deeply cloned copy of the object
  Example
```
const original = { user: { name: 'John', hobbies: ['reading'] } };
const cloned = ObjectUtils.cloneObject(original);
cloned.user.name = 'Jane'; // Original remains unchanged
```
  - Defined in ObjectUtils.ts:32
deepEqual:function
- deepEqual(obj1, obj2): boolean
- Performs a deep equality check between two values, comparing all nested properties.
  Parameters
  - obj1: unknown
    The first value to compare
  - obj2: unknown
    The second value to compare
  Returns boolean
  True if the values are deeply equal, false otherwise
  Example
```
ObjectUtils.deepEqual({ a: { b: 1 } }, { a: { b: 1 } }); // Returns true
ObjectUtils.deepEqual({ a: 1 }, { a: 2 }); // Returns false
ObjectUtils.deepEqual([1, 2, 3], [1, 2, 3]); // Returns true
```
  - Defined in ObjectUtils.ts:65
filterUniqueByProp:function
- filterUniqueByProp<T>(objects, prop): T[]
- Filters an array of objects to unique values based on a specified property.
  Type Parameters
  - T extends Record<string, unknown>
    The type of objects in the array
  Parameters
  - objects: T[]
    The array of objects to filter
  - prop: keyof T
    The property to use for uniqueness comparison
  Returns T[]
  An array containing only unique objects based on the specified property
  Example
```
const users = [
  { id: 1, name: 'John' },
  { id: 2, name: 'Jane' },
  { id: 1, name: 'John Doe' }
];
ObjectUtils.filterUniqueByProp(users, 'id'); // Returns first two objects
```
  - Defined in ObjectUtils.ts:109
filterByKeys:function
- filterByKeys(obj, keys): Record<string, unknown>
- Filters an object to only include the specified keys.
  Parameters
  - obj: Record<string, unknown>
    The object to filter
  - keys: string[]
    An array of keys to include in the filtered object
  Returns Record<string, unknown>
  A new object containing only the specified keys
  Example
```
const user = { id: 1, name: 'John', email: 'john@example.com', password: 'secret' };
ObjectUtils.filterByKeys(user, ['id', 'name']); // Returns { id: 1, name: 'John' }
```
  - Defined in ObjectUtils.ts:134
findFirstNonZeroIndex:function
- findFirstNonZeroIndex(data): number
- Finds the index of the first non-zero value in an object of numbers.
  Parameters
  - data: Record<string, number>
    An object containing numeric values
  Returns number
  The index of the first non-zero value, or -1 if all values are zero
  Example
```
ObjectUtils.findFirstNonZeroIndex({ a: 0, b: 0, c: 5, d: 2 }); // Returns 2
ObjectUtils.findFirstNonZeroIndex({ a: 0, b: 0 }); // Returns -1
```
  - Defined in ObjectUtils.ts:153
flatten:function
- flatten(obj, prefix?): Record<string, unknown>
- Flattens a nested object into a single-level object with dot-notation keys.
  Parameters
  - obj: Record<string, unknown>
    The object to flatten
  - prefix: string = ""
    The prefix to use for nested keys (default: empty string)
  Returns Record<string, unknown>
  A flattened object with dot-notation keys
  Example
```
const nested = { user: { profile: { name: 'John', age: 30 } } };
ObjectUtils.flatten(nested);
// Returns { 'user.profile.name': 'John', 'user.profile.age': 30 }
```
  - Defined in ObjectUtils.ts:169
fromMap:function
- fromMap<T>(map): Record<string, T>
- Converts a Map to a plain object
  Type Parameters
  - T
  Parameters
  - map: Map<string, T> | Record<string, T>
    Map to convert
  Returns Record<string, T>
  Plain object
  - Defined in ObjectUtils.ts:196
getNestedProp:function
- getNestedProp<T>(obj, ...path): null | T
- Gets a nested property from an object
  Type Parameters
  - T
  Parameters
  - obj: Record<string, unknown>
    Object to get property from
  - Rest ...path: string[]
    Path to property
  Returns null | T
  Property value or null if not found
  - Defined in ObjectUtils.ts:207
groupByProp:function
- groupByProp<T>(objects, ...propPath): Record<string, T[]>
- Groups objects by a property value
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - objects: T[]
    Array of objects to group
  - Rest ...propPath: string[]
    Path to property to group by
  Returns Record<string, T[]>
  Object with grouped arrays
  - Defined in ObjectUtils.ts:237
hasNestedProp:function
- hasNestedProp(obj, ...path): boolean
- Checks if an object has a nested property
  Parameters
  - obj: Record<string, unknown>
    Object to check
  - Rest ...path: string[]
    Path to property
  Returns boolean
  True if property exists
  - Defined in ObjectUtils.ts:271
isEmpty:function
- isEmpty(obj): boolean
- Checks if an object is empty
  Parameters
  - obj: unknown
    Object to check
  Returns boolean
  True if object is empty
  - Defined in ObjectUtils.ts:295
isFunction:function
- isFunction(value): value is Function
- Checks if a value is a function
  Parameters
  - value: unknown
    Value to check
  Returns value is Function
  True if value is a function
  - Defined in ObjectUtils.ts:307
isEqual:function
- isEqual(obj1, obj2): boolean
- Checks if two objects are equal using JSON stringification
  Parameters
  - obj1: unknown
    First object to compare
  - obj2: unknown
    Second object to compare
  Returns boolean
  True if objects are equal
  - Defined in ObjectUtils.ts:317
isEqualOnKeys:function
- isEqualOnKeys(obj1, obj2, keys): boolean
- Compares objects based on specified keys
  Parameters
  - obj1: Record<string, unknown>
    First object to compare
  - obj2: Record<string, unknown>
    Second object to compare
  - keys: string[]
    Array of keys to compare
  Returns boolean
  True if objects are equal on specified keys
  - Defined in ObjectUtils.ts:329
isObject:function
- isObject(value): value is Record<string, unknown>
- Checks if a value is an object
  Parameters
  - value: unknown
    Value to check
  Returns value is Record<string, unknown>
  True if value is an object
  - Defined in ObjectUtils.ts:345
mapByProp:function
- mapByProp<T>(objects, ...propPath): Record<string, T>
- Maps objects by a property value
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - objects: T[]
    Array of objects to map
  - Rest ...propPath: string[]
    Path to property to map by
  Returns Record<string, T>
  Object with mapped values
  - Defined in ObjectUtils.ts:355
matchesRules:function
- matchesRules<T>(obj, ruleSet): boolean
- Checks if an object conforms to a set of rules
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to check
  - ruleSet: Record<keyof T, ((value) => boolean)>
    Object containing validation functions
  Returns boolean
  True if object conforms to all rules
  - Defined in ObjectUtils.ts:379
merge:function
- merge<T>(...objects): T
- Deep merges two or more objects
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - Rest ...objects: T[]
    Objects to merge
  Returns T
  Merged object
  - Defined in ObjectUtils.ts:393
omit:function
- omit<T>(obj, keys): Partial<T>
- Creates a new object with specified keys omitted
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to omit keys from
  - keys: string[]
    Keys to omit
  Returns Partial<T>
  New object without specified keys
  - Defined in ObjectUtils.ts:419
pick:function
- pick<T>(obj, keys): Partial<T>
- Creates a new object with only the specified keys
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to pick from
  - keys: string[]
    Keys to pick
  Returns Partial<T>
  New object with only specified keys
  - Defined in ObjectUtils.ts:435
removeNullishValues:function
- removeNullishValues<T>(obj, noEmptyStrings?): Partial<T>
- Removes null, undefined, and optionally empty string values from an object
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to clean
  - noEmptyStrings: boolean = false
    Whether to remove empty strings
  Returns Partial<T>
  Cleaned object
  - Defined in ObjectUtils.ts:447
replaceEmptyStringsWithNull:function
- replaceEmptyStringsWithNull(obj, deep?): Record<string, unknown>
- Replaces empty strings with null in an object
  Parameters
  - obj: Record<string, unknown>
    Object to process
  - deep: boolean = false
    Whether to process nested objects
  Returns Record<string, unknown>
  Processed object
  - Defined in ObjectUtils.ts:470
replaceKey:function
- replaceKey<T>(obj, oldKey, newKey): Record<string, unknown>
- Replaces a key in an object
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to modify
  - oldKey: keyof T
    Key to replace
  - newKey: string
    New key name
  Returns Record<string, unknown>
  New object with replaced key
  - Defined in ObjectUtils.ts:507
replaceNullWithEmptyString:function
- replaceNullWithEmptyString(obj, fields?): Record<string, unknown>
- Replaces null values with empty strings in an object
  Parameters
  - obj: Record<string, unknown>
    Object to process
  - Optional fields: string[]
    Optional array of fields to process
  Returns Record<string, unknown>
  Processed object
  - Defined in ObjectUtils.ts:529
setNestedProp:function
- setNestedProp<T>(obj, ...path): null | T
- Sets a nested property in an object
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to modify
  - Rest ...path: [...string[], unknown]
    Path to property
  Returns null | T
  New object with set property
  - Defined in ObjectUtils.ts:550
sortByProp:function
- sortByProp<T>(__namedParameters): T[]
- Sorts an array of objects by a property
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - __namedParameters: {
        objects: T[];
        prop: keyof T;
        direction?: "asc" | "desc";
    }
    - objects: T[]
    - prop: keyof T
    - Optional direction?: "asc" | "desc"
  Returns T[]
  Sorted array
  - Defined in ObjectUtils.ts:590
toMap:function
- toMap<T>(obj): Map<string, T>
- Converts an object to a Map
  Type Parameters
  - T
  Parameters
  - obj: Record<string, T>
    Object to convert
  Returns Map<string, T>
  Map
  - Defined in ObjectUtils.ts:614
transform:function
- transform<T>(obj, keyTransform?, valueTransform?): Record<string, unknown>
- Transforms an object's keys and/or values
  Type Parameters
  - T extends Record<string, unknown>
  Parameters
  - obj: T
    Object to transform
  - Optional keyTransform: ((key) => string)
    Function to transform keys
    - (key): string
      Parameters
      key: string
      Returns string
  - Optional valueTransform: ((value) => unknown)
    Function to transform values
    - (value): unknown
      Parameters
      value: unknown
      Returns unknown
  Returns Record<string, unknown>
  Transformed object
  - Defined in ObjectUtils.ts:626

Variable ObjectUtilsConst

Type declaration

cloneObject:function

Type Parameters

Parameters

Returns T

Example

deepEqual:function

Parameters

Returns boolean

Example

filterUniqueByProp:function

Type Parameters

Parameters

Returns T[]

Example

filterByKeys:function

Parameters

Returns Record<string, unknown>

Example

findFirstNonZeroIndex:function

Parameters

Returns number

Example

flatten:function

Parameters

Returns Record<string, unknown>

Example

fromMap:function

Type Parameters

Parameters

Returns Record<string, T>

getNestedProp:function

Type Parameters

Parameters

Returns null | T

groupByProp:function

Type Parameters

Parameters

Returns Record<string, T[]>

hasNestedProp:function

Parameters

Returns boolean

isEmpty:function

Parameters

Returns boolean

isFunction:function

Parameters

Returns value is Function

isEqual:function

Parameters

Returns boolean

isEqualOnKeys:function

Parameters

Returns boolean

isObject:function

Parameters

Returns value is Record<string, unknown>

mapByProp:function

Type Parameters

Parameters

Returns Record<string, T>

matchesRules:function

Type Parameters

Parameters

Returns boolean

merge:function

Type Parameters

Parameters

Returns T

omit:function

Type Parameters

Parameters

Returns Partial<T>

pick:function

Type Parameters

Parameters

Returns Partial<T>

removeNullishValues:function

Type Parameters

Variable ObjectUtils`Const`

`Optional` direction?: "asc" | "desc"