Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drawbotics/morphey
A small utility to transform keys and values of an object using a template.
https://github.com/drawbotics/morphey
javscript keys nodejs utility
Last synced: about 1 month ago
JSON representation
A small utility to transform keys and values of an object using a template.
- Host: GitHub
- URL: https://github.com/drawbotics/morphey
- Owner: Drawbotics
- License: mit
- Created: 2017-02-22T19:27:05.000Z (almost 8 years ago)
- Default Branch: dev
- Last Pushed: 2018-03-27T08:34:59.000Z (almost 7 years ago)
- Last Synced: 2023-02-26T11:16:05.261Z (almost 2 years ago)
- Topics: javscript, keys, nodejs, utility
- Language: JavaScript
- Size: 47.9 KB
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Morphey
A small utility to change keys and values of an object according to another object that describes the transformations. It's important to notice that this function **doesn't mutate the original object** and returns a new one instead.
[](https://www.npmjs.com/package/morphey)
[](https://travis-ci.org/larsbs/morphey)
## Installation
Install it using yarn:
```bash
$ yarn add morphey
```
Or, if you're an old school guy, using npm:
```bash
$ npm install --save morphey
```
## Example
A basic usage example:
```js
import morphey, { fromKey, fromValue } from 'morphey'; // or const morphey = require('morphey');
// translations can be a function or an object. If it's a function, the original
// object would be passed as the first arg.
const translations = (obj) => {
foo: fromKey('bar'),
test: fromKey('old').using((v) => v * 2),
'deep.x': fromKey('deepX'),
'deep.y': fromKey('deep.deep.Y'),
computed: fromValue(obj.deepX * obj.deep.deep.Y),
};
const initialObject = {
bar: 123,
old: 10,
deepX: 2,
deep: {
deep: { Y: 3 },
},
};
const final = morphey(initialObject, translations);
console.log(final); // will print
const f = {
foo: 123,
test: 20,
deep: {
x: 2,
y: 3,
},
computed: 6,
};
```
## Motivation
This small utility allows to change keys and values of an object according to a description of those changes. This can be useful in multiple situations. For example, when you need to communicate with an external service through JSON but the keys the service is expecting are different than the one you want to use, when you want to filter some keys from one object, when you want to sanitize values or compute some of the them on the fly, etc.
But, what's the point of having those transformations in a description object? Well, first of all it makes easier to know what's happening at first glance. Second, this provides an unified way of doing this operation that can be shared across the entire team and across the entire code base.
Basically, it's easier to understand this:
```js
const translations = (obj) => {
foo: fromKey('bar'),
test: fromKey('old').using((v) => v * 2),
'deep.x': fromKey('deepX'),
'deep.y': fromKey('deep.deep.Y'),
};
const final = morphey(initialObject, translations);
```
Than this:
```js
const final = Object.keys(initialObject).reduce((memo, k) => {
if (k === 'bar') {
return { ...memo, foo: initialObject[k] };
}
else if (k === 'old') {
return { ...memo, test: initialObject[k] * 2 };
}
else if (k === 'deepX') {
return { ...memo, deep: { ...memo.deep, x: initialObject[k] } };
}
// It's not possible to easily do deep.y
}, {});
```
And all of this without taking into account that every developer in the team can have his own way of doing this or the need to repeat this code everytime someone is going to change the shape of an object.
## API
#### `morphey(obj, morphs)`
> Creates a new object from `obj` using the transformations in `morphs`.
- **Parameters**
- `obj` *Object*: The object to use as a base for the new object.
- `morphs` *Object|Function*: The transformations to apply to the base object for obtaining the new object.
- **Returns**
- *Object*: A new object resulting of applying the transformations to the base object.
Transformations descriptions are objects with keys as the new names of the properties of the resulting object and values that describe where to find the data in the original object. This data finding process can be specified using two methods.
##### `fromKey`
> In progress
##### `fromValue`
> In progress
## License
MIT. See [LICENSE](LICENSE) for details.