copy-to

What is copy-to?

The 'copy-to' npm package is a utility for copying properties from one object to another. It is useful for shallow copying and merging objects, which can be particularly handy in various scenarios such as data manipulation, configuration management, and more.

What are copy-to's main functionalities?

Copy properties from one object to another

This feature allows you to copy all properties from a source object to a target object. It is useful for creating a new object with the same properties as an existing one.

const copy = require('copy-to');
const target = {};
const source = { a: 1, b: 2 };
copy(source).to(target);
console.log(target); // { a: 1, b: 2 }

Copy selected properties

This feature allows you to copy only selected properties from the source object to the target object. It is useful when you only need specific properties from an object.

const copy = require('copy-to');
const target = {};
const source = { a: 1, b: 2, c: 3 };
copy(source).pick('a', 'c').to(target);
console.log(target); // { a: 1, c: 3 }

Copy properties except some

This feature allows you to copy all properties except the specified ones from the source object to the target object. It is useful when you want to exclude certain properties.

const copy = require('copy-to');
const target = {};
const source = { a: 1, b: 2, c: 3 };
copy(source).except('b').to(target);
console.log(target); // { a: 1, c: 3 }

Other packages similar to copy-to

lodash

Lodash is a popular utility library that provides a wide range of functions for manipulating arrays, objects, and other data types. It includes methods like _.assign and _.merge for copying and merging objects. Compared to 'copy-to', Lodash offers a more comprehensive set of utilities but may be overkill if you only need simple copy functionalities.

object-assign

Object-assign is a simple and lightweight package for copying properties from one or more source objects to a target object. It is similar to 'copy-to' in terms of functionality but does not offer the ability to pick or exclude specific properties.

deepmerge

Deepmerge is a utility for deep merging objects, meaning it can handle nested objects and arrays. While 'copy-to' focuses on shallow copying, deepmerge is useful when you need to merge objects with nested structures.

README

copy-to

copy an object's properties to another one, include propertiy, getter and setter.

Install

npm install copy-to

Usage

copy(src).to(des);
copy(src).toCover(des);
copy(src).override(des);

copy(src).pick('proName1', 'proName2').to(des);
copy(src).pick('proName1', 'proName2').toCover(des);
copy(src).pick('proName1', 'proName2').override(des);

copy(src).and(other).to(des);
copy(src).and(other).toCover(des);
copy(src).and(second).and(third).to(des);

copy(src).and(other).pick('proName1', 'proName2').to(des);
copy(src).and(other).pick('proName1', 'proName2').toCover(des);
copy(src).and(second).and(third).pick('proName1', 'proName2').to(des);

It won't copy access(getter / setter) by default, if you want to copy them, please use:

copy(src).withAccess().and(other).to(des);

Example

var copy = require('copy-to');

var src = {
  _name: 'foo',
  set name(val) {
    this._name = val;
  },
  get name() {
    return this._name;
  },
  show: function () {
    console.log(this._name);
  }
};

var des = {
  _name: 'bar'
};

copy(src).to(des);
copy(src).toCover(des);
copy(src).pick('_name', 'name').to(des);
copy(src).pick('_name', 'name').toCover(des);

License

MIT