https://github.com/spatie/fatten
Transform dot-notation-like objects into optimised nested objects.
https://github.com/spatie/fatten
array javascript transformation
Last synced: 6 months ago
JSON representation
Transform dot-notation-like objects into optimised nested objects.
- Host: GitHub
- URL: https://github.com/spatie/fatten
- Owner: spatie
- License: mit
- Created: 2023-05-04T13:27:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-08T05:33:54.000Z (over 2 years ago)
- Last Synced: 2025-04-14T10:43:00.643Z (6 months ago)
- Topics: array, javascript, transformation
- Language: TypeScript
- Homepage: https://spatie.be/open-source
- Size: 193 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Transform dot-notation-like objects into optimised nested objects
[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
[![Downloads][downloads-img]][downloads-url]
[![Issues][issues-img]][issues-url]
[![Code Coverage][codecov-img]][codecov-url]
```ts
// 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
[
](https://spatie.be/github-ad-click/spatie.be)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
```bash
npm install fatten
```
```bash
yarn add fatten
```
## Usage
```ts
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:
> ```ts
> 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](https://github.com/spatie/fatten/releases) for more information what has changed recently.
## Testing
```bash
npm run test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.
## Credits
- [Sam Apostel](https://github.com/Sam-Apostel)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[build-img]:https://github.com/spatie/fatten/actions/workflows/release.yml/badge.svg
[build-url]:https://github.com/spatie/fatten/actions/workflows/release.yml
[downloads-img]:https://img.shields.io/npm/dt/fatten
[downloads-url]:https://www.npmtrends.com/fatten
[npm-img]:https://img.shields.io/npm/v/fatten
[npm-url]:https://www.npmjs.com/package/fatten
[issues-img]:https://img.shields.io/github/issues/spatie/fatten
[issues-url]:https://github.com/spatie/fatten/issues
[codecov-img]:https://codecov.io/gh/spatie/fatten/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/spatie/fatten