Object Utils

Object Utils is a library made to help with objects manipulation!

Installation

npm install @olucasandrade/object-utils

Table of Contents

• addValue
  • Parameters
• convert
  • Parameters
• copy
  • Parameters
• countTypes
  • Parameters
• filter
  • Parameters
• hasKey
  • Parameters
• hasValue
  • Parameters
• isDeepEqual
  • Parameters
• isEmpty
  • Parameters
• isEqual
  • Parameters
• isObject
  • Parameters
• map
  • Parameters
• removeValue
  • Parameters
• swapPairs
  • Parameters

addValue

Add a value to an object

Parameters

• object Object Object to be manipulated
• key
• value any Value to be added
• allowUndefined Boolean If true, function will add even undefined values (optional, default false)

Returns Object Object after add

convert

Convert values from object

Parameters

• object Object Object to be manipulated
• type
• target string Optional param to define a specific value to be converted
• value ("string" | "number" | "date" | "boolean") type to be converted to

Returns Object Object after conversion

copy

Copy an object without connection

Parameters

• object Object Object to be copied

Returns Object Object after copy

countTypes

Count types from object

Parameters

• object Object Object to be counted

Returns Object Object with count of all types

filter

Filter values from object

Parameters

• object Object Object to be filtered
• fn function (any): Boolean function to filter
• removeOriginal Boolean If true, original object will be filtered (optional, default false)

Returns Object Object after add

hasKey

Verify if an object contains a key

Parameters

• object Object Object to be verified
• value any Value to be searched

Returns Boolean

hasValue

Verify if an object contains a value

Parameters

• object Object Object to be verified
• value any Value to be searched

Returns Boolean

isDeepEqual

Verify if two objects are deeply equal

Parameters

• object1 Object Object to be compared
• object2 Object Object to be compared

Returns Boolean

isEmpty

Verify if an object is empty

Parameters

• object Object Object to be verified

Returns Boolean

isEqual

Verify if two objects are equal

Parameters

• object1 Object Object to be compared
• object2 Object Object to be compared

Returns Boolean

isObject

Verify if a value is an object

Parameters

• value any Value to be verified

Returns Boolean

map

Verify if two objects are equal

Parameters

• object Object Object to be mapped
• fn function (): any Function whose return produces the element of the new Object

Returns Object Object after map

removeValue

Add a value to an object

Parameters

• object Object Object to be manipulated
• value any Value to be removed

Returns Object Object after remove

swapPairs

Swap keys by values from object

Parameters

• object Object Object to be swapped

Returns Object Object after swap