serialize-json

A serialize algorithm for JSON

Usage no npm install needed!

<script type="module">
  import serializeJson from 'https://cdn.skypack.dev/serialize-json';
</script>

README

serialize-json

A serialize algorithm for JSON

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Introduction

  • Support serialize JSON to Buffer, and deserialize Buffer to JSON

    • [√] Boolean
    • [√] String
    • [√] Number
    • [√] Null
    • [√] Undefined
    • [√] Date
    • [√] Buffer
    • [√] Error
    • [√] Plain Object
    • [×] Function
    • [×] RegExp
    • [×] Symbol

  • Inspire by jsonpack, it can compress to 55% of original size if the data has a recursive structure

Install

$ npm install serialize-json --save

Node.js >= 4.0.0 required

Usage

let json = {
  a: 'a',
  b: 123,
  c: 123.456,
  d: [ 1, 2, 3 ],
  e: true,
  f: null,
  g: undefined,
  h: new Date(),
  i: new Buffer('this is a buffer'),
  j: new Error('this is a error'),
};
const buf = JSON.encode(json);
const result = JSON.decode(buf);
assert.deepEqual(result, json);

API

  • encode(json) serialize a json object
  • decode(buf) deserialize a buffer to json