https://github.com/zoubin/util-mix
Object mixing methods
https://github.com/zoubin/util-mix
Last synced: 14 days ago
JSON representation
Object mixing methods
- Host: GitHub
- URL: https://github.com/zoubin/util-mix
- Owner: zoubin
- Created: 2015-05-13T09:39:34.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-05T05:23:05.000Z (over 10 years ago)
- Last Synced: 2025-09-21T07:37:28.652Z (9 months ago)
- Language: JavaScript
- Size: 219 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# util-mix
Object mixing methods
## Usage
```javascript
var mix = require('util-mix');
var Mixer = require('util-mix/Mixer');
var o = mix({ a: 1 }, { b: 2 }); // { a: 1, b: 2 }
var mixer = Mixer({ a: 0, b: 0 });
o = mixer.mix({}); // { a: 0, b: 0 }
o = mixer.mix({ c: 1 }); // { a: 0, b: 0, c: 1 }
```
## mix(receiver, src1, src2,...)
Mix own properties supplied by *src1*, *src2*,..., into *receiver*, which must be a non-null object.
Same key causes overwriting, the later appearance in *arguments* the winner.
The *receiver* will be returned.
```javascript
var r = {};
var o = mix(r, { x:1, y:1 }, { y:2 });
o === r; // true
o; // { x:1, y:2 }
```
## mix-undef(receiver, src1, src2,...)
Same with `mix`, except that properties are only mixed when not defined in `receiver`.
```javascript
var mix = require('util-mix/mix-undef');
var o = { x: 1 };
mix(o, { x: 2 }, { y: 2 }, { z: 3 }, { x: 3 });
o; // { x: 1, y: 2, z: 3 }
```
## merge(src1, src2,...)
Same as `mix({}, src1, src2,...)`.
```javascript
var r = {};
var o = merge(r, { x:1, y:1 }, { y:2 });
r; // {}
o; // { x:1, y:2 }
```
## copy(src)
Same as `merge`.
## pick(filter, src1, src2,...)
### filter
Type: `String`, `Array`
Same as `merge(src1, src2,...)`, but only keys specified in `filter` appear in the result.
```javascript
var o = pick(['x', 'y'], { x:1, y:1 }, { y:2 }, { z:3 });
o; // { x:1, y:2 }
```
## unpick(filter, src1, src2,...)
### filter
Type: `String`, `Array`
Merge all properties from `src1, src2,...` except those appear in `filter`
```javascript
var o = unpick(['x', 'y'], { x:1, y:1 }, { y:2 }, { z:3 });
o; // { z:3 }
```
## chop(filter, o)
### filter
Type: `String`, `Array`
`pick` keys specified by `filter` from `o`, and delete them from `o`.
```javascript
var o = { x:1, y:2, z:3 };
var chopped = chop(['x', 'y'], o);
chopped; // { x:1, y:2 }
o; // { z:3 }
```
## Class: Mixer
### methods
#### mix(receiver, src1, src2,...)
#### merge(src1, src2,...)
### mixer = Mixer(filter, defaults)
#### filter
Type: `Array`
Only mix keys contained in `filter`.
#### defaults
Type: `Object`
Always mix `defaults`, and it will always be overwritten.
```javascript
var mixer = Mixer(['x', 'y'], { x:1 });
var opts = {};
var o = mixer.mix(opts, { y:2, z:3 });
o === opts; // true
o; // { x:1, y:2 }
```
### mixer = Mixer(o)
#### o
Type: `Object`
Same as `Mixer(Object.keys(o), o)`
```javascript
var mixer = Mixer({ x:1, y:1 });
var o = mixer.merge({ y:2 }, { z:3 });
o === opts; // true
o; // { x:1, y:2 }
```