Encoding an object in TypeScript with functions and a looping reference network

Question

Encoding an object in TypeScript with functions and a looping reference network

Currently, I'm dealing with a complex project in TypeScript that heavily relies on object-oriented programming, resulting in a quite intricate object graph (including objects that indirectly point to themselves). My need now is to serialize this graph into a string. Is there any way to achieve this in TypeScript without losing crucial information during de-serialization?

Ideally, I am looking for a solution that minimizes the required bookkeeping on each new class added.

Here are some methods I have experimented with:

JSOG. Unfortunately, this approach was unsuccessful because upon de-serialization, the objects were left as type Object and lost their associated methods.
TypedJSON. This method also failed due to the
```
Uncaught TypeError: cyclic object value
```
error.
A combination of both approaches: Despite trying to pass an object created by jsog-typescript to TypedJSON, it was rejected for not being the correct type.

typescript serialization jsog

Answer 1

Answer №1

I pondered the issue of circular references and class simultaneously, which led me to create a package that addresses this concern.

https://github.com/denostack/superserial

One striking demonstration of the capabilities of this library:

import { Serializer } from 'superserial'

const serializer = new Serializer()

{
  // Illustrating a recursive map
  const map = new Map();
  map.set(map, map);

  const serialized = serializer.serialize(map);
  console.log(serialized); // output: Map($0=>$0)

  const deserialized = serializer.deserialize("Map($0=>$0)");

  console.log(deserialized === [...deserialized.keys()][0]); // true
  console.log(deserialized === deserialized.get([...deserialized.keys()][0])); // true
}

{
  // Demonstrating nested objects and recursion
  const obj = { foo: { bar: {} } }
  obj.foo.bar.baz = obj

  const serialized = serializer.serialize(obj);
  console.log(serialized); // output: {"foo":$1};{"bar":$2};{"baz":$0}

  const deserialized = serializer.deserialize('{"foo":$1};{"bar":$2};{"baz":$0}');

  console.log(deserialized) // output: <ref *1> { foo: { bar: { baz: [Circular *1] } } }
  console.log(deserialized.foo.bar.baz === deserialized) // true
}

Answer 2

I pondered the issue of circular references and class simultaneously, which led me to create a package that addresses this concern.

https://github.com/denostack/superserial

One striking demonstration of the capabilities of this library:

import { Serializer } from 'superserial'

const serializer = new Serializer()

{
  // Illustrating a recursive map
  const map = new Map();
  map.set(map, map);

  const serialized = serializer.serialize(map);
  console.log(serialized); // output: Map($0=>$0)

  const deserialized = serializer.deserialize("Map($0=>$0)");

  console.log(deserialized === [...deserialized.keys()][0]); // true
  console.log(deserialized === deserialized.get([...deserialized.keys()][0])); // true
}

{
  // Demonstrating nested objects and recursion
  const obj = { foo: { bar: {} } }
  obj.foo.bar.baz = obj

  const serialized = serializer.serialize(obj);
  console.log(serialized); // output: {"foo":$1};{"bar":$2};{"baz":$0}

  const deserialized = serializer.deserialize('{"foo":$1};{"bar":$2};{"baz":$0}');

  console.log(deserialized) // output: <ref *1> { foo: { bar: { baz: [Circular *1] } } }
  console.log(deserialized.foo.bar.baz === deserialized) // true
}

Answer 3

Answer №2

Ultimately, I decided to create my own serialization tool

Answer 4

Ultimately, I decided to create my own serialization tool

Answer 5

Answer №3

While the original author may have posted this information late, it could still be beneficial to others.

We encountered a similar issue with circular references and experimented with various Object-Oriented Programming (OOP) techniques involving polymorphic structures. Despite trying popular serializers like class-transformer and TypedJSON, we found they did not fully meet our needs in a convenient manner.

In response, we developed our own open-source serializer, which can be found here:

https://github.com/dipscope/TypeManager.TS

This serializer offers multiple solutions for handling circular object references and provides customization options.

Answer 6

While the original author may have posted this information late, it could still be beneficial to others.

We encountered a similar issue with circular references and experimented with various Object-Oriented Programming (OOP) techniques involving polymorphic structures. Despite trying popular serializers like class-transformer and TypedJSON, we found they did not fully meet our needs in a convenient manner.

In response, we developed our own open-source serializer, which can be found here:

https://github.com/dipscope/TypeManager.TS

This serializer offers multiple solutions for handling circular object references and provides customization options.

Encoding an object in TypeScript with functions and a looping reference network

Answer №1

Answer №2

Answer №3

Similar questions

Utilizing the String Enum for mapping an interface with an index

Could you please clarify the type of event on the onInputChange props?

What about incorporating unique images with custom HTML input tags?

Finding out whether the current date falls between a startDate and endDate within a nested object in mongoose can be done by using a specific method

Discover the type of an object in TypeScript

Adding a JSON object to an API call: step-by-step guide

Why are my animation states being shared among different instances of the component?

Setting up the Angular2 library with a defaultExtension for systemjs configuration

The upcoming router is not compatible with the NextPage type

What purpose does the pipe method serve in RxJS?

Displaying errors from an API using Angular Material mat-error

Sending JSON object data to an API endpoint using the POST method in an Angular application

Error: No 'map' property found in 'TwitterserviceService' type

Problems arise during the installation of TypeScript typings for .NET Core

One-liner in TypeScript for quickly generating an object that implements an interface

There seems to be an issue with Material-UI and TypeScript where a parameter of type 'string' does not have an index signature in the type 'ClassNameMap<"container" | "navBar" | "section0">'

Angular firebase Error: The parameter 'result' is missing a specified type and is implicitly assigned the 'any' type

Calculate the difference between two arrays containing objects using ES6 or TypeScript

Getting access to a function within the same TypeScript file from another exported function in Angular

Is it possible to silence the other person's audio using livekit?