https://github.com/vicanso/simple-stringify

simple stringify json for node.js
https://github.com/vicanso/simple-stringify

log stringify

Last synced: 8 months ago
JSON representation

simple stringify json for node.js

• Host: GitHub
• URL: https://github.com/vicanso/simple-stringify
• Owner: vicanso
• License: mit
• Created: 2016-10-20T12:33:02.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-08T13:20:02.000Z (about 8 years ago)
• Last Synced: 2025-01-28T01:04:51.536Z (over 1 year ago)
• Topics: log, stringify
• Language: JavaScript
• Homepage:
• Size: 41 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# simple-stringify

[![Build Status](https://travis-ci.org/vicanso/simple-stringify.svg?branch=master)](https://travis-ci.org/vicanso/simple-stringify)

[![Coverage Status](https://img.shields.io/coveralls/vicanso/simple-stringify/master.svg?style=flat)](https://coveralls.io/r/vicanso/simple-stringify?branch=master)

[![npm](http://img.shields.io/npm/v/simple-stringify.svg?style=flat-square)](https://www.npmjs.org/package/simple-stringify)

[![Github Releases](https://img.shields.io/npm/dm/simple-stringify.svg?style=flat-square)](https://github.com/vicanso/simple-stringify)

Simple way stringify json for log.

## Installation

```js

$ npm install simple-stringify

```

## API

```js

const stringify = require('simple-stringify');

const data = {

  no: 123,

  mobile: null,

  addresss: undefined,

  disabled: false,

  name: 'tree.xie',

  keywords: [

    'koa',

    'framework',

    'albi',

  ],

  infos: {

    url : 'https://github.com/vicanso/albi/issues',

    email: 'vicansocanbico@gmail.com'

  },

};

// no=123 mobile=null addresss=undefined disabled=false name="tree.xie" keywords=[] infos={}

stringify.json(data);

```

### divider

The divider for stringify, default is ' '.

```js

const stringify = require('simple-stringify');

stringify.divider = ',';

```

### isSecret

Determine if it is confidential by key. If return true, the value will be ***.

```js

const stringify = require('simple-stringify');

stringify.isSecret = key => key === 'password';

// account="tree.xie" password="***"

stringify.json({

  password: '123456',

});

```

### json

Stringify json data

- `level` format level, default is stringify.maxLevel

```js

const stringify = require('simple-stringify');

const data = {

  no: 123,

  mobile: null,

  addresss: undefined,

  disabled: false,

  name: 'tree.xie',

  keywords: [

    'koa',

    'framework',

    'albi',

  ],

  infos: {

    url : 'https://github.com/vicanso/albi/issues',

    email: 'vicansocanbico@gmail.com'

  },

};

// no=123 mobile=null addresss=undefined disabled=false name="tree.xie" keywords=[] infos={}

stringify.json(data);

// no=123 mobile=null addresss=undefined disabled=false name="tree.xie" keywords=[0="koa" 1="framework" 2="albi"] infos={url="https://github.com/vicanso/albi/issues" email="vicansocanbico@gmail.com"}

stringify.json(data, 2);

```

### maxLevel

Set stringify max level, default is 1

```js

const stringify = require('simple-stringify');

stringify.maxLevel = 2;

const data = {

  no: 123,

  mobile: null,

  addresss: undefined,

  disabled: false,

  name: 'tree.xie',

  keywords: [

    'koa',

    'framework',

    'albi',

  ],

  infos: {

    url : 'https://github.com/vicanso/albi/issues',

    email: 'vicansocanbico@gmail.com'

  },

};

// no=123 mobile=null addresss=undefined disabled=false name="tree.xie" keywords=[0="koa" 1="framework" 2="albi"] infos={url="https://github.com/vicanso/albi/issues" email="vicansocanbico@gmail.com"}

stringify.json(data);

```

## Benchmarks

```

JSON.stringify 1000000 times, use:2438ms

simple-stringify json 1000000 times, use:1684ms

```

## License

MIT