Transform dot-notation-like objects into optimised nested objects
!npm packagenpm-imgnpm-url
!Build Statusbuild-imgbuild-url
!Downloadsdownloads-imgdownloads-url
!Issuesissues-imgissues-url
!Code Coveragecodecov-imgcodecov-url// Fatten turns flat objects
const 😡 = { id: 5, user_id: 14, user_name: 'Jane', payment_provider: 'stripe' };
// Into optimised nested objects
const 😍 = { id: 5, user: { id: 14, name: 'Jane' }, paymentProvider: 'stripe' };
// By doing this
const 🤯 = fatten(😡, { separator: '_' });
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
npm install fatten
yarn add fatten
Usage
import { fatten } from 'fatten';
const options = {
separator: '-',
leafKey: 'value'
};
const nestedObject = fatten(flatObject, options);
Options (optional)
separator
(default: '.'
)
The character used to split the keys of the flat object. leafKey
(default: '_'
)
The key that represents a node with a value inside a deeper path.Example:const result = fatten({ id: 5, 'id.version': '2', type: 'mailable' }) // is the same as const result = { id: { _: 5, version: '2' }, type: 'mailable' }
Changelog
Please see releases for more information what has changed recently.Testing
npm run test