json-stringify-extended

json-stringify-extended

JSON.stringify any data types

Purpose

• Stringify more than primitive types into JSON format
• Stringify in JavaScript Object
• Use not yet defined types (like enums)
• Avoid useless quotes
• Choose to throw exception or not in circularity references

Installing

npm i json-stringify-extended

Quick start

const stringify = require('json-stringify-extended')

const data = {
  a: 'basic set, default options',
  b: 1,
  c: true,
  d: function (a, b) { console.log(a + b) },
  e: {a: 0, b: 0.1, c: -2},
  f: ['a', 'b', 'c'],
  g: new Date('2017-01-01'),
  h: /a|b/,
  i: null,
  j: Infinity,
  k: NaN,
  l: undefined,
  m: stringify.deferred('my.enum.VALUE'),
  n: Buffer.from('7468697320697320612074c3a97374', 'hex')
}

console.log(stringify(data))

// output
{
  a:"basic set, default options",
  b:1,
  c:true,
  d:function (a, b) { console.log(a + b) },
  e:{
    a:0,
    b:0.1,
    c:-2
  },
  f:[
    "a",
    "b",
    "c"
  ],
  g:new Date("2017-01-01T00:00:00.000Z"),
  h:/a|b/,
  i:null,
  j:Infinity,
  k:NaN,
  l:undefined,
  m:my.enum.VALUE,
  n:Buffer.from("dGhpcyBpcyBhIHTDqXN0")
}

Supported types

• String
• Number
• Boolean
• function
• Object
• Array
• Date
• RegExp
• Buffer
• null
• Infinity
• NaN
• undefined
• not-yet-defined using stringify.deferred

API docs

stringify(data[, options])

Stringify data into string

data

Type: any

options

Type: Object

Options to adjust result format.

You can also use prepared options:

• stringify.options.json format to regular JSON format
• stringify.options.standadjs format using standadjs rules
• stringify.options.compact format without folding, quotes and spaces

example

const data = {a: 'string', b: false, c: [0, 1, 2]}
console.log(stringify(data, stringify.options.compact))
// output
{a:'string',b:false,c:[0,1,2]}

options.safe

Type: Boolean
Default: false

Works in safe mode, so will not throws exception for circularity.

options.endline

Type: String
Default: \n

Endline string, should be only spacing chars as \n or \r\n. Set to empty string '' for one line output.

options.spacing

Type: String
Default: (two spaces)

Indentation string, should contains only spacing chars as \t or spaces .

options.compress

Type: Boolean
Default: false

Compress data for function and Date discard null and undefined values, but don't remove spaces and useless quotes.

options.filter

Type: function(key:String, value:String) return Boolean
Default: null

Use function to filter by key and/or value each element.
Return true to keep element or false to discard.
filter is applied before replace.

example

const data = {
  user: 'alice',
  password: 'it-s-a-secret',
  id: 1,
  meta: ['1', 1],
  greet: function() { return 'hi' }
}
const options = {
  filter: function (key, value) {
    if (key === 'password') {
      return false
    }
    if (value === 1) {
      return false
    }
    if (typeof value === 'function') {
      return false
    }
    return true
  }
}
console.log(stringify(data, options))
// output
{
  user:"alice",
  meta:[
    "1"
  ]
}

options.replace

Type: function(key:String, value:String) return {key, value}
Default: null

Use function to replace key and/or value of each element.
Must return an object {key, value}.
filter is applied before replace.

example

const data = {
  user: 'alice',
  password: 'it-s-a-secret',
  id: 1,
  meta: ['1', 1]
}
const options = {
  replace: function (key, value) {
    if (key === 'password') {
      return {key: 'secret', value: '***'}
    }
    if (value === 1) {
      return {key, value: 'one'}
    }
    return {key, value}
  }
}
console.log(stringify(data, options))
// output
{
  user:"alice",
  secret:"***",
  id:"one",
  meta:[
    "1",
    "one"
  ]
}

options.keyQuote

Type: String
Default: null

Character used for quote keys, default is null, means no quotes in keys. Should be " or ' or null

options.valueQuote

Type: String
Default: '

Character used for quote values, default is '. Should be " or '

options.keySpace

Type: Boolean
Default: false

Add a space beetwen key: and value.

options.discard

Type: Boolean
Default: false

Discard null and undefined values.

TODO

• output compatibility: es5, es6
• coverage badge
• browser support
  • (see)[https://www.contentful.com/blog/2017/04/04/es6-modules-support-lands-in-browsers-is-it-time-to-rethink-bundling/]

License

The MIT License (MIT)

Copyright (c) 2017-2018 braces lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.