https://github.com/jpeer264/node-json-extra
A node module to give you more power for json files
https://github.com/jpeer264/node-json-extra
json json-extra json-files json-parser json-string nodejs
Last synced: 5 months ago
JSON representation
A node module to give you more power for json files
- Host: GitHub
- URL: https://github.com/jpeer264/node-json-extra
- Owner: JPeer264
- Created: 2015-10-22T09:29:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T03:18:52.000Z (about 3 years ago)
- Last Synced: 2025-08-18T14:13:54.122Z (8 months ago)
- Topics: json, json-extra, json-files, json-parser, json-string, nodejs
- Language: TypeScript
- Size: 1.66 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# json-extra
[]((https://travis-ci.org/JPeer264/node-json-extra))
[](https://coveralls.io/github/JPeer264/node-json-extra)
> `json-extra` gives you a little more power to json files and strings
## Getting started
```sh
npm install --save json-extra
```
or
```sh
yarn add json-extra
```
## Usage
With `json-extra` you can do such things like read json files and directly parse them into an object or just create a new json file.
`JSON.parse` and `JSON.stringify` is also attached to `json-extra`.
Include `json-extra` as follows:
```js
import * as json from 'json-extra';
```
## Sync vs. Async
Example:
```js
import { write, writeSync } from 'json-extra';
// Promises:
write('/any/path/you/want', 'filename.json', '{json: "string or object"}')
.then(() => console.log('success!'))
.catch(err => console.error(err))
// Sync:
try {
writeSync('/any/path/you/want', 'filename.json', '{json: "string or object"}')
console.log('success!')
} catch (err) {
console.error(err)
}
```
## Methods
- [isJson](#isJson)
- [isJsonString](#isJsonString)
- [chain](#chain)
- [readToObj](#readToObj)
- [readToObjSync](#readToObj)
- [write](#write)
- [writeSync](#write)
- [find](#find)
### isJson()
**isJson(json)**
Checks if the input is a valid json object
Example:
```js
import { isJson } from 'json-extra';
isJson({ myJson: '' }); // true
isJson('{ myJson: '' }'); // false
isJson('nope'); // false
```
### isJsonString()
**isJsonString(jsonString)**
Checks if the given string would be a valid json object
Example:
```js
import { isJsonString } from 'json-extra';
isJsonString('{ myJson: '' }'); // true
isJsonString({ myJson: '' }); // false
isJsonString('nope'); // false
```
### chain()
**chain(json[, options])**
Options:
- type (array | string): Get specific types. Available options: `array`, `object`, `string`, `boolean` or `number`
- delimiter (string): Changes the delimiter between the chained strings. Default: `'/'`
Example:
```js
import { chain } from 'json-extra';
var myJsonString = {
myJson: {
sub: [
'components',
'pages',
'services',
],
},
};
chain(myJsonString);
// returns: [ 'myJson', 'myJson/sub', 'myJson/sub/components', 'myJson/sub/pages', 'myJson/sub/services' ]
chain(myJsonString, { type: 'array' });
// returns: [ 'myJson/sub' ]
chain(myJsonString, { type: 'string' });
// returns: [ 'myJson/sub/components', 'myJson/sub/pages', 'myJson/sub/services' ]
```
### readToObj()
**readToObj(path)**
Read a json file and returns an obj.
Sync: `readToObjSync()`
Example:
```js
import { readToObj } from 'json-extra';
// read a json file and return an object
readToObj('/path/to/json')
.then(data => console.log('My nice data: ', data))
.catch(console.error);
```
### write()
**write(path, filename[, content])**
write a new json file. The content could be a object or a json string.
Sync: `writeSync()`
Example:
```js
import { write } from 'json-extra';
// writed a new json file
write('/any/path/you/want', 'filename.json', '{json: "string or object"}')
.then(() => console.log('Written!'))
.catch(console.error);
```
### find()
**find(jsonObject, findString[, options])**
Finds a specific key in the json
Options:
- type (array | string): Get specific types. Available options: `array`, `object`, `string`, `boolean` or `number`
- max (boolean): The maximum of keys to find. Default: `-1` alias unlimited
Example:
```js
import { find, readToObj } from 'json-extra';
const myJsonObejct = readToObj('./package.json')
const foundKeys = find(myJsonObject, 'dependencies')
// returns: [ { key: 'dependencies', type: 'object', data: {} } ]
```