Giter Club home page Giter Club logo

graph-serializer's Introduction

graph-serializer

Graph serializer is a lightweight library for converting JSON data structures to typed objects usable in typescript. Benefits include better type checking in your IDE, better type safety, and standardized date conversion. Primary use case is for easy integration of RESTful services and typescript.

Installation

Add graph-serializer to your dependencies:

npm i --save @syslogic/graph-serializer

Usage

Graph-serializer provides an annotation which you can use in your typescrpt entities. You can use the @serializable to specify which properties need to be (de)serialized.

The serialize and deserialize functions can then be used with the entity

Basic usage

import {serializable, deserialize, serialize} from "@syslogic/graph-serializer"

class Foo {
    @serializable()
    public thisWillBeSerialized: string = 'test';
}

let fooObj = deserialize(Foo, {thisWillBeSerialized: 'bar'}); // fooOjb instanceof Foo === true
let fooGraph = serialize(new Foo()); //  fooGraph = {thisWillBeSerialized: 'bar'}

Advanced

There are a few serializer parameters to seraialize all sorts of serializers. Check the test directory for more examples. Features include:

  • Proper Date deserialization
  • Nested serialization
  • Serialize and deserialize including subclasses (class hierarchy)
  • Arrays, multilevel arrays
  • Object maps / Hash maps
  • Union types
  • Polymorphic arrays

graph-serializer's People

Contributors

holkerveen avatar harmenm 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.