https://github.com/slavahatnuke/object.gs
Object Get Set interface
https://github.com/slavahatnuke/object.gs
Last synced: 2 months ago
JSON representation
Object Get Set interface
- Host: GitHub
- URL: https://github.com/slavahatnuke/object.gs
- Owner: slavahatnuke
- Created: 2017-03-18T05:21:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-17T02:07:15.000Z (almost 8 years ago)
- Last Synced: 2025-03-01T01:13:42.829Z (3 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ogs - Object / Get / Set
`O`bject, `G`et, `S`et
- +`D`el
- +`M`ap
Object getter and setter interface.
This solution allows to manage object fields in `fn()` way.
## Install:
- `npm install ogs --save`
## Interface
- `get(path, separator = '.')` -> getter(object) -> value
- `set(path, separator = '.')` -> setter(object) -> objectSetter(value)
- `del(path, separator = '.')` -> deleter(object)
- `map(mapping, separator = '.')` -> mapper(object|array) -> result object|array
## Spec
### Get
```javascript
const assert = require('assert');
const {get, set, del} = require('..');
describe('Get', () => {
it('get field', () => {
let object = {key: 10};
let getter = get('key');
assert.equal(10, getter(object));
});
it('get nested field', () => {
let object = {a: {b: {d: 2}}, c: 3};
assert.equal(2, get('a.b.d')(object));
assert.deepEqual({d: 2}, get('a.b')(object));
});
it('get by array key', () => {
let object = {x: {Y: {Z: 25}}};
let getter = get(['x', 'Y', 'Z']);
assert.equal(25, getter(object));
});
it('get wrong key', () => {
let object = {};
let getter = get('xxx');
assert.equal(undefined, getter(object));
});
it('get wrong nested key', () => {
let object = {};
let getter = get('xxx.yyy.zzz');
assert.equal(undefined, getter(object));
});
});
```
### Set
```javascript
const assert = require('assert');
const {get, set, del} = require('..');
describe('Set', () => {
it('set field', () => {
let object = {};
let setter = set('key');
let objectSetter = setter(object);
assert.deepEqual({key: 10}, objectSetter(10));
assert.deepEqual({key: 20}, objectSetter(20));
assert.deepEqual({key: 35}, objectSetter(35));
assert.deepEqual({key: 35}, object);
});
it('set nested field', () => {
let object = {key: 1};
let setter = set('key.xxx.yyy');
let objectSetter = setter(object);
assert.deepEqual({key: {xxx: {yyy: 11}}}, objectSetter(11));
assert.deepEqual({key: {xxx: {yyy: 11}}}, object);
assert.deepEqual({key: {xxx: {yyy: undefined}}}, objectSetter(undefined));
});
});
```
### Del
```javascript
const assert = require('assert');
const {get, set, del} = require('..');
describe('Delete', () => {
it('del field', () => {
let object = {key: 1};
let deleter = del('key');
deleter(object);
assert.deepEqual({}, object);
});
it('del nested field', () => {
let object = {key: {xxx: {aaa: 1}}};
let deleter = del('key.xxx.aaa');
assert.deepEqual({key: {xxx: {}}}, deleter(object));
});
it('del nested field not exists', () => {
let object = {key: {xxx: {aaa: 2}}};
let deleter = del('key.xxx.aaa');
assert.deepEqual({key: {xxx: {}}}, deleter(object));
});
});
```
### Map
```javascript
const assert = require('assert');
const {map, get} = require('..');
describe('Map', () => {
it('Map object', () => {
let object = {
path: {
to: {
data: 'OK here'
}
}
};
let mapper = map({
key: 'path.to.data'
});
let data = mapper(object);
assert.deepEqual({key: 'OK here'}, data);
});
it('Map array', () => {
let object1 = {
path: {
to: {
data: 'OK here'
}
}
};
let object2 = {
path: {
to: {
data: 'New one here'
}
}
};
let object3 = {
path: {
to: {
// nothing here
}
}
};
let mapper = map({
key: 'path.to.data'
});
let data = mapper([object1, object2, object3]);
assert.deepEqual([
{
key: 'OK here'
},
{
key: 'New one here'
},
{
key: undefined
}
], data);
});
it('Map nested array', () => {
let user = {
userName: 'slava',
userComments: [
{
id: 1,
text: 'Hey guys'
},
{
id: 2,
text: 'Test here'
}
]
};
let userMapper = map({
name: 'userName',
comments: ({userComments}) => userComments.map(get('text'))
});
let data = userMapper(user);
assert.deepEqual({
name: 'slava',
comments: ['Hey guys', 'Test here']
}, data);
});
it('Map object with nested result fields', () => {
let object = {
path: {
to: {
data: 'OK here'
}
}
};
let mapper = map({
'nested.key.here': 'path.to.data',
'nested.key.new': 'path.to'
});
let data = mapper(object);
assert.deepEqual({
nested: {
key: {
here: 'OK here',
new: {
data: 'OK here'
}
}
}
}, data);
});
});
```