Code Monkey home page Code Monkey logo

serializer's Introduction

Serializer

A simple dependency-free recursive class/interface serializer.

Installation

npm i @jexsrs/serializer

Initialization

First we have to create an array of the types we want to serialize:

const types = [Person, Pet]; // The order must always be the same

Where Person and Pet are the following classes

class Person {
    name: string;
    pet: Pet;
}

class Pet {
    name: string;
}

Then we initialize the Serializer with the given types:

import {Serializer} from "@jexsrs/serializer";

const srz = new Serializer(types);

After that you can serialize and deserialize the classes as follows:

const pet = new Pet();
pet.name = 'Fluffy';

const person = new Person();
person.name = 'Michael';
person.pet = pet;

const serialized: string = srz.serialize(person);
const desrialized: Person = srz.deserialize(serialized);

Keep in mind

The serializer is recursive but cannot handle circular entries, for example:

class Person {
    name: string;
    pet: Pet;
}

class Pet {
    name: string;
    owner: Person;
}

const pet = new Pet();
pet.name = 'Fluffy';

const person = new Person();
person.name = 'Michael';
person.pet = pet;

pet.owner = person; // This will cause the failure

const serialized: string = srz.serialize(person); // !!! This will fail
const desrialized: Person = srz.deserialize(serialized);

serializer's People

Contributors

jexsrs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.