What is assign-symbols?
The assign-symbols npm package is designed to copy enumerable and non-enumerable symbols from one or more source objects to a target object. This is particularly useful when you need to ensure that all properties, including symbols, are transferred between objects, which is not handled by standard methods like Object.assign.
What are assign-symbols's main functionalities?
Copying symbols
This feature allows the copying of symbols from one or more source objects to a target object. It is useful for ensuring that all properties, including non-enumerable and symbol-typed properties, are copied.
const assignSymbols = require('assign-symbols');
const target = {};
const source = {};
Symbol.for('mySymbol') = 'value';
source[Symbol.for('mySymbol')] = 'copied value';
assignSymbols(target, source);
console.log(target[Symbol.for('mySymbol')]); // 'copied value'
Other packages similar to assign-symbols
extend
Similar to assign-symbols, the 'extend' package can also copy properties from one object to another. However, it primarily focuses on copying own properties and does not specifically handle symbols as assign-symbols does.
object-assign
This package offers functionality similar to Object.assign but includes fixes for certain edge cases. Like assign-symbols, it is used to copy properties from source objects to a target object, but it does not handle symbols specifically.
assign-symbols
Assign the enumerable es6 Symbol properties from one or more objects to the first object passed on the arguments. Can be used as a supplement to other extend, assign or merge methods as a polyfill for the Symbols part of the es6 Object.assign method.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install
Install with npm:
$ npm install --save assign-symbols
About
A symbol is a unique and immutable data type and may be used as an identifier for object properties. The symbol object is an implicit object wrapper for the symbol primitive data type. - Mozilla Developer docs for Symbol
Usage
const assignSymbols = require('assign-symbols');
let target = {};
let one = {};
let symbolOne = Symbol('aaa');
one[symbolOne] = 'bbb';
let two = {};
let symbolTwo = Symbol('ccc');
two[symbolTwo] = 'ddd';
assignSymbols(target, one, two);
console.log(target[symbolOne]);
console.log(target[symbolTwo]);
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb
Related projects
You might also be interested in these projects:
- assign-deep: Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… more | homepage
- clone-deep: Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives. | homepage
- extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util. | homepage
- merge-deep: Recursively merge values in a javascript object. | homepage
- mixin-deep: Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone… more | homepage
Contributors
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on August 06, 2018.