@synanetics/document-db-serializer

This packages provides serialization and deserialization functionality for storing and retrieving non JSON native JavaScript types in document databases.

Usage

import { serializeData, deserializeData } from '@synanetics/document-db-serializer';

const data: Data = {
    test: "test",
    url: new URL("https://www.example.com/"),
};

// serializeData return infers serializedData's type
const serializedData = serializeData(data);

// Write data to document database

// Read data from document database

// deserializedData's return is unknown, assert for subsequent data use
const deserializedData = deserializeData(readData) as Data;

// deserializedData is equal to data

Currently Targeted Serializations

This package currently serializes the following JavaScript types:

• URL
• Date

To support more non JSON native JavaScript types, add to the serializations array and update the Serialized type.