ObjectUtils

A small collection of utility methods to work with objects that relies on extend for deep merge and copy.

Examples

merge

Make a deep merge of a list of objects.

const objA = { a: 'first' };
const objB = { b: 'second' };

console.log(ObjectUtils.merge(objA, objB));
// Will output { a: 'first', b: 'second' }

copy

Make a deep copy of an object.

const objA = { a: 'first' };
const objB = ObjectUtils.copy(objA);
objA.b = 'second';

console.log(objB);
// Will output { a: 'first' }

get

Read a property from an object using a path:

const obj = {
  propOne: {
    propOneSub: 'Charito!',
  },
  propTwo: '!!!',
};

console.log(ObjectUtils.get(
  obj,
  'propOne.propOneSub'
));
// Will output 'Charito!'

set

Set a property on an object using a path. If the path doesn't exist, it will be created.

const target = {};

console.log(ObjectUtils.set(target, 'some.prop.path', 'some-value'));
// Will output { some: { prop: { path: 'some-value' } } }

extract

Extracts a property or properties from an object in order to create a new one.

const target = {
  name: {
    first: 'Rosario',
  },
  age: 3,
  address: {
    planet: 'earth',
    something: 'else',
  },
};

console.log(ObjectUtils.set(obj, [
  { 'name': 'name.first'},
  'age',
  'address.planet'
]));
// Will output { name: 'Rosario', age: 3, address: { planet: 'earth' } }

delete

Delete a property of an object using a path. If by removing a property of a sub object, the object has no more keys, it also removes it.

const target = {
  propOne: {
    propOneSub: 'Charito!',
  },
  propTwo: '!!!',
};

console.log(ObjectUtils.delete(
  target,
  'propOne.propOneSub'
));
// Will output { propTwo: '!!!' }

flat

Flatterns an object properties into a single level dictionary.

const target = {
  propOne: {
    propOneSub: 'Charito!',
  },
  propTwo: '!!!',
};

console.log(ObjectUtils.flat(target);
// Will output { 'propOne.propOneSub': 'Charito!', propTwo: '!!!' }

unflat

This method does the exact opposite from flat: It takes an already flattern object and restores it structure.

const target = {
  'propOne.propOneSub': 'Charito!
  propTwo: '!!!',
};

console.log(ObjectUtils.unflat(target);
// Will output { propOne: { propOneSub: 'Charito!' }, 'propTwo': '!!!' }

formatKeys

Formats all the keys on an object using a way similar to .replace(regexp, ...) but that also works recursively and with "object paths".

const target = {
  prop_one: 'Charito!',
};
console.log(ObjectUtils.formatKeys(
  target,
  // Find all the keys with snake case.
  /([a-z])_([a-z])/g,
  // Using the same .replace style callback, replace it with lower camel case.
  (fullMatch, firstLetter, secondLetter) => {
    const newSecondLetter = secondLetter.toUpperCase();
    return `${firstLetter}${newSecondLetter}`;
  }
));

ObjectUtils also provides a few "shorthand implementations" of formatKeys:

• lowerCamelToSnakeKeys(...)
• lowerCamelToDashKeys(...)
• snakeToLowerCamelKeys(...)
• snakeToDashKeys(...)
• dashToLowerCamelKeys(...)
• dashToSnakeKeys(...)

ES Modules

If you are using ESM, you can import the class from the /esm sub path:

import ObjectUtils from 'wootils/esm/shared/objectUtils';

// or

import { ObjectUtils } from 'wootils/esm/shared';

Technical documentation

• Class: ObjectUtils

If you are reading this form the markdown document, you can go to the online version; or you can generate the documentation site yourself by running the docs command:

# You can either use npm or yarn, it doesn't matter
npm run docs && open ./docs/index.html;