Blame view

node_modules/assign-symbols/README.md 2.69 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
  # assign-symbols [![NPM version](https://badge.fury.io/js/assign-symbols.svg)](http://badge.fury.io/js/assign-symbols)
  
  > Assign the enumerable es6 Symbol properties from an object (or 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.
  
  From the [Mozilla Developer docs for Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol):
  
  > 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.
  
  ## Install
  
  Install with [npm](https://www.npmjs.com/)
  
  ```sh
  $ npm i assign-symbols --save
  ```
  
  ## Usage
  
  ```js
  var assignSymbols = require('assign-symbols');
  var obj = {};
  
  var one = {};
  var symbolOne = Symbol('aaa');
  one[symbolOne] = 'bbb';
  
  var two = {};
  var symbolTwo = Symbol('ccc');
  two[symbolTwo] = 'ddd';
  
  assignSymbols(obj, one, two);
  
  console.log(obj[symbolOne]);
  //=> 'bbb'
  console.log(obj[symbolTwo]);
  //=> 'ddd'
  ```
  
  ## Similar projects
  
  * [assign-deep](https://www.npmjs.com/package/assign-deep): Deeply assign the enumerable properties of source objects to a destination object. | [homepage](https://github.com/jonschlinkert/assign-deep)
  * [clone-deep](https://www.npmjs.com/package/clone-deep): Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives. | [homepage](https://github.com/jonschlinkert/clone-deep)
  * [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow)
  * [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep)
  * [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)
  
  ## Running tests
  
  Install dev dependencies:
  
  ```sh
  $ npm i -d && npm test
  ```
  
  ## Contributing
  
  Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/assign-symbols/issues/new).
  
  ## Author
  
  **Jon Schlinkert**
  
  + [github/jonschlinkert](https://github.com/jonschlinkert)
  + [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  
  ## License
  
  Copyright © 2015 Jon Schlinkert
  Released under the MIT license.
  
  ***
  
  _This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on November 06, 2015._