# transobj

> easy to change Object's structor

Latest version **1.0.4** (published 2018-09-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install transobj
pnpm add transobj
yarn add transobj
bun add transobj
```

## 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.4 |
| Published | 2018-09-23 |
| First published | 2018-09-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Weiqing Ji |
| Maintainers | drugcoder |
| Keywords | interface |

## Links

- npm: https://www.npmjs.com/package/transobj
- npm.io page: https://npm.io/package/transobj

## Recent versions

- 1.0.4 (latest) — 2018-09-23
- 1.0.3 — 2018-09-23
- 1.0.2 — 2018-09-23
- 1.0.0 — 2018-09-23

## README

```js
npm install transobj
```

#### demo
```js
const Obj = {
    aa: 1,
    bb: ['12', '123', '888'],
    cc: [{
        aaa: '999',
        bbb: {
            ccc: '456'
        }
    }, {
        aaa: '1234',
        bbb: {
            ccc: '4567'
        }
    }],
    dd: {
        aa: '555',
        ddd: {
            eee: '666'
        }
    }
}

let x = transObj(Obj, {
    aa: Number,
    bb: Array,
    cc: [{
        aaa: String,
        bbb: {
            ccc: String
        }
    }],
    dd: {
        'aa|1': String,
        ddd: {
            eee: String
        }
    }
}, {
    xx: {
        aaa: 'aa|1',
        bbb: 'dd'
    },
    nn: {
        yy: [{
            uuu: 'bb',
            yyy: 'aaa'
        }]
    }
})

console.log(JSON.stringify(x))
```

#### 可以根据将对象的结构轻松改变为你想要的结构，当然会有损耗性能，若对性能有极致的要求，不建议使用本方法（It is possible to easily change the structure of the object to the structure you want, and of course there will be lossy performance. If the performance is extremely demanding, this method is not recommended）。

#### 只需要设置两次结构，即可轻松得到结果。同时也可让数据结构在代码中轻松可见（You only need to set up the structure twice to get the results easily. It also makes the data structure easy to see in the code.）。

- 这是原对象（This is the original object）。
```js
const transObj=require('transobj')

const Obj = {
    aa: 1,
    bb: ['12', '123', '888'],
    cc: [{
        aaa: '999',
        bbb: {
            ccc: '456'
        }
    }, {
        aaa: '1234',
        bbb: {
            ccc: '4567'
        }
    }],
    dd: {
        aa: '555',
        ddd: {
            eee: '666'
        }
    }
}
```
- 第一步：先建立需要用到的数据结构，这样先检索得以优化性能，若key值重名了，则可将key值改写为'aa|1'（The first step: first establish the data structure that needs to be used, so that the first retrieval can optimize the performance. If the key value is the same, the key value can be rewritten as 'aa|1'）。
```js
{
    aa: Number,
    bb: Array,
    cc: [{
        aaa: String,
        bbb: {
            ccc: String
        }
    }],
    dd: {
        'aa|1': String,
        ddd: {
            eee: String
        }
    }
}
```
- 第二步：建立想要得到的结果的数据结构，在值中设定源数据中对应的key值即可（Step 2: Establish the data structure of the desired result, and set the corresponding key value in the source data in the value）。
```js
{
    xx: {
        aaa: 'aa|1',
        bbb:'dd'
    },
    nn: {
        yy: [{
            uuu: 'bb',
            yyy: 'aaa'
        }]
    }
}
```
- Here we go！这就是结果（This is the result）。
```js
{
    "xx": {
        "aaa": "555",
        "bbb": {
            "aa": "555",
            "ddd": {
                "eee": "666"
            }
        }
    },
    "nn": {
        "yy": [{
            "uuu": "12",
            "yyy": "999"
        }, {
            "uuu": "123",
            "yyy": "1234"
        }, {
            "uuu": "888",
            "yyy": null
        }]
    }
}
```

- 代码上只需要如下操作（Only the following operations are required on the code）。
```js
let x = transObj(Obj, {
    aa: Number,
    bb: Array,
    cc: [{
        aaa: String,
        bbb: {
            ccc: String
        }
    }],
    dd: {
        'aa|1': String,
        ddd: {
            eee: String
        }
    }
}, {
    xx: {
        aaa: 'aa|1',
        bbb: 'dd'
    },
    nn: {
        yy: [{
            uuu: 'bb',
            yyy: 'aaa'
        }]
    }
})
```

- 注意：暂不支持二维数组及以上的数据操作（Note: Data operations for 2D arrays and above are not supported at this time）。

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