https://github.com/scientanl/graph-serializer

Graph Serializer
https://github.com/scientanl/graph-serializer

Last synced: 10 days ago
JSON representation

Graph Serializer

• Host: GitHub
• URL: https://github.com/scientanl/graph-serializer
• Owner: ScientaNL
• License: mit
• Created: 2018-04-16T09:09:54.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2023-05-16T08:22:00.000Z (over 1 year ago)
• Last Synced: 2024-04-14T00:55:11.751Z (9 months ago)
• Language: TypeScript
• Size: 538 KB
• Stars: 4
• Watchers: 7
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

```shell

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

```typescript

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](tests/) 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