Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dizmo/functions-json2tree
dizmoFun: JSON to tree mapper
https://github.com/dizmo/functions-json2tree
dizmo function javascript json library mapper tree typescript
Last synced: about 16 hours ago
JSON representation
dizmoFun: JSON to tree mapper
- Host: GitHub
- URL: https://github.com/dizmo/functions-json2tree
- Owner: dizmo
- License: isc
- Created: 2018-11-08T13:16:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T13:42:31.000Z (about 1 year ago)
- Last Synced: 2024-11-07T02:16:18.275Z (9 days ago)
- Topics: dizmo, function, javascript, json, library, mapper, tree, typescript
- Language: TypeScript
- Size: 998 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://npmjs.org/package/@dizmo/functions-json2tree)
[](https://travis-ci.com/dizmo/functions-json2tree)
[](https://coveralls.io/github/dizmo/functions-json2tree?branch=master)
# @dizmo/functions-json2tree
Provides two functions `array2tree` and `object2tree`, where:
* `array2tree`: maps an array via an `apply` function, until the array is completely mapped, or `apply` returns `false`.
The array is a recursive description of a tree, where the *value* of a given node is at index `0` of the array followed *optionally* by other arrays, each containing the *name* followed by a *sub-tree* for any given sub-nodes. Each sub-tree is again yet another array according to the same recursive description.
* `object2tree`: maps a JSON-like object via an `apply` function, until the object is completely mapped or `apply` returns `false`.
The object conforms to the same rules like any regular JSON or JavaScript object, with the addition that the values of nodes can be directly represented using an underscore `_` for the key value.
## Usage
### Install
```sh
npm install @dizmo/functions-json2tree --save
```
### Require
```javascript
const { array2tree, object2tree } = require('@dizmo/functions-json2tree');
```
### Examples
```typescript
import { array2tree, object2tree } from '@dizmo/functions-json2tree';
```
```typescript
declare const db: {
// db should set value for given path (or root)
set: (key: string | null, value: any) => any;
};
```
```typescript
array2tree("path/to/a-node", [
"α"
], db.set);
array2tree("path/to/b-node", [
"β", ["i", [0]], ["j", [1]], ["k", [2]]
], db.set);
array2tree("path/to/c-node", [
"γ", ["x", ["ξ", ["y", ["υ", ["z", ["ζ"]]]]]]
], db.set);
```
```typescript
object2tree("path/to/a-node", {
_: "α"
}, db.set);
object2tree("path/to/b-node", {
_: "β", i: 0, j: 1, k: 2
}, db.set);
object2tree("path/to/c-node", {
_: "γ", x: {_: "ξ", y: {_: "υ", z: "ζ"}}
}, db.set);
```
## Development
### Clean
```sh
npm run clean
```
### Build
```sh
npm run build
```
#### without linting and cleaning:
```sh
npm run -- build --no-lint --no-clean
```
#### with UMD bundling (incl. minimization):
```sh
npm run -- build --prepack
```
#### with UMD bundling (excl. minimization):
```sh
npm run -- build --prepack --no-minify
```
### Lint
```sh
npm run lint
```
#### with auto-fixing:
```sh
npm run -- lint --fix
```
### Test
```sh
npm run test
```
#### without linting, cleaning and (re-)building:
```sh
npm run -- test --no-lint --no-clean --no-build
```
### Cover
```sh
npm run cover
```
#### without linting, cleaning and (re-)building:
```sh
npm run -- cover --no-lint --no-clean --no-build
```
## Documentation
```sh
npm run docs
```
## Publish
```sh
npm publish
```
#### initially (if public):
```sh
npm publish --access=public
```
## Copyright
© 2020 [dizmo AG](http://dizmo.com/), Switzerland