# nested-beautifier

> Small library that beautifies MySql results

Latest version **1.0.12** (published 2017-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install nested-beautifier
pnpm add nested-beautifier
yarn add nested-beautifier
bun add nested-beautifier
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2017-07-28 |
| First published | 2017-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Pasca Ovidiu Ionut |
| Maintainers | pascaionut94 |

## Links

- npm: https://www.npmjs.com/package/nested-beautifier
- Repository: https://github.com/ovidiuionut94/nested-beautifier
- Homepage: https://github.com/ovidiuionut94/nested-beautifier#readme
- Issues: https://github.com/ovidiuionut94/nested-beautifier/issues
- npm.io page: https://npm.io/package/nested-beautifier

## Recent versions

- 1.0.12 (latest) — 2017-07-28
- 1.0.11 — 2017-07-28
- 1.0.10 — 2017-07-27
- 1.0.9 — 2017-07-19
- 1.0.8 — 2017-07-18
- 1.0.7 — 2017-07-18
- 1.0.6 — 2017-07-18
- 1.0.5 — 2017-07-18
- 1.0.4 — 2017-07-18
- 1.0.3 — 2017-07-18
- 1.0.2 — 2017-07-18
- 1.0.1 — 2017-07-18
- 1.0.0 — 2017-07-18

## README

# nested-beautifier

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ovidiuionut94/djin/nested_beautifier/LICENSE) 
[![Code Climate](https://codeclimate.com/github/ovidiuionut94/djin/badges/gpa.svg)](https://codeclimate.com/github/ovidiuionut94/djin)

Small library that beautifies MySql results

Usually, when you're trying to get some complex data from a MySql server, the response needs
more computation to get it into a tree form. For example, when you're joining two tables, TableA and TableB, that are bonded
with a one to many relationship, you get a response like the following:

```js
result: [
{
  TableA: { id: 1 },
  TableB: { id: 1 }
},
{
  TableA: { id: 1  someMoreData... },
  TableB: { id: 2, someMoreData... }
}
...
]
// Observe that for every different TableB that is bonded with a TableA record, the data
// from TableA is duplicated
```

Wouldn't it be nice if you could transform this kind of data into a tree-like structure like the followig ?!

```js
result: [
  {
    TableA: {
      id: 1,
      TableB: [
        {
          id: 1,
          someMoreData...
        },
        {
          id: 2,
          someMoreData...
        }
      ]
  }
]
```
You can now achieve that using the "nested-beautifier"

# First steps
- Install the beautifier

```
npm install --save nested-beautifier
```

### Parameters


The nested-beautifier takes two parameters (Yeah... 2)

The first one is, obviously, a response got from MySql.

The second parameter must contain some information about the very first table from MySql that is included in the query.

For example, if we are using <b> 'SELECT [someData] FROM TableA INNER JOIN [someOtherTables]' </b>,
the second parameter will become an object like the following : 
```js
{
  idAttr: [a uniq table column, like id],
  name: 'TableA'
}
```

If the parent table doesn't contain a uniq column, then the 'nested-beautifier' will create a uniq
hash for every diffrent parent data.


### Usage

```js
// You need to require the library
var Beautifier = require('nested-beautifier')

// Say that we have a MySql response
var mySqlQuery = `SELECT * FROM TableA 
  INNER JOIN TableB ON TableB.tableAId = TableA.id`;
  
var MySqlResponse = ExecuteMySqlQuery(mySqlQuery);


var parentData = {
  idAttr: 'id',
  name: 'TableA'
}
var beautifiedResponse = Beautifier.beautify(MySqlResponse, parentData);
// That's all folks
```

---
_Source: https://npm.io/package/nested-beautifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._