jdad

0.2.0 • Public • Published

jDad

A javascript serialization/deserialization library similar to JSON but with following extended features:

  • Support circular reference
  • Support Date object
  • Support RegExp object
  • Support Buffer/Binary object
  • Support function type object
  • Escape HTML charaters and JavaScript line terminators (see serialize-javascript)

All the above additional features are optional and could be able to enable/disable during serialization and/or deserialization.

API

jDad.stringify(obj, options):

  • Avaliable options
  • buffer:
    • Boolean true/false to turn on and off the feature. Default false.
    • 'string' Buffer will be converted to their string representation e.g. '<Buffer 50>'
  • cycle
    • Boolean true/false to turn on and off the feature. Default false.
  • date:
    • Boolean true/false to turn on and off the feature. Default false.
  • function
    • Boolean true/false to turn on and off the feature. Default false.

    • 'string' Function will be converted to their string representation e.g. 'function() {}'.

    • 'object' Function will be converted to their object representation e.g.

      '{ "type": "Function", "function": "function() {}"}'.

  • regexp:
    • Boolean true/false to turn on and off the feature. Default false.
    • 'string' RegExp will be converted to their string representation e.g. '/(ab|cd)/gm/'.
  • safe - the unsafe characters should be replaced by their Unicode counterparts.
    • Boolean true/false to turn on and off the feature. Default false.

jDad.parse(str, options):

Following options will only work when their corresponding stringify options are true.

  • options
  • buffer:
    • Boolean true/false to turn on and off the feature. Default false.
    • 'string' Buffer will be converted to their string representation e.g. '<Buffer 50>'
  • decycle
    • Boolean true/false to turn on and off the feature. Default false.
  • date:
    • Boolean true/false to turn on and off the feature. Default false.
    • 'string' Date will be converted to their ISO string representation.
  • function
    • Boolean true/false to turn on and off the feature. Default false.
    • 'string' Function will be converted to their string representation e.g. 'function() {}'.
  • regexp:
    • Boolean true/false to turn on and off the feature. Default false.
    • 'string' RegExp will be converted to their string representation e.g. '/(ab|cd)/gm/'.

Similar Projects

https://github.com/primus/ejson

https://github.com/douglascrockford/JSON-js

https://github.com/yahoo/serialize-javascript.git

https://github.com/WebReflection/circular-json

https://github.com/graniteds/jsonr

Credits

Modified based on the awesome works of following projects:

  1. serialize-javascript
  2. JSON-js

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i jdad

Weekly Downloads

3

Version

0.2.0

License

MIT

Last publish

Collaborators

  • lsm