Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 3.49 KB

README.md

File metadata and controls

98 lines (67 loc) · 3.49 KB
Raw

Vilanova

DISCLAIMER: This library is still at early development, so use it at your own risk!

JSON stringify and parse where transformations for types can be defined in a pluggable way in Node.js.

By default, it is able to stringify and parse objects that contains BigInt numbers.

TABLE OF CONTENTS

Installation

npm install vilanova

Example of use

const Vilanova = require('vilanova');

const obj = { id: 1, name: 'name', value: 123456789012345678901234567890n };
const str = Vilanova.stringify(obj);
const newObj = Vilanova.parse(str);

Using CircularJSON

Vilanova allows you to use your own stringify and parse functions. One of the most used is CircularJSON.

const CircularJSON = require('circular-json');
const Vilanova = require('vilanova');

const obj = { id: 1, name: 'name', value: 123456789012345678901234567890n };
const str = Vilanova.stringify(obj, CircularJSON.strinfigy);
const newObj = Vilanova.parse(str, CircularJSON.parse);

Adding custom types

To add a custom type, you can use Vilanova.addType method. You must provide the name of the type, the reviver function and the replacer function. The reviver function should always return an string that starts with #<type>:, where <type> should be an string where it's lower case is the name of the type that you're adding. The replacer is the way to create the target object from the string. Example:

Vilanova.addType('BigInt', value => `#BigInt:${value}`, value => BigInt(value));

Also, you must rewrite the Vilanova.getType method to recognize the type. The type recognition is done in one function instead of a function per type due to performance, so only one function is launched to recognize the type given a value.

Contributing

You can read the guide of how to contribute at Contributing.

Code of Conduct

You can read the Code of Conduct at Code of Conduct.

Who is behind it?

This project is developed by Jesus seijas.

If you need to contact me, you can do it at the email jseijas@gmail.com

License

Copyright (c) Jesus Seijas.

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.