josm-serializer v1.0.0

Josm serializer

Searializer and deserializer for josm. Serialize and deserialize pass by reference JSON constructs as shown in the example below.

Example

Define a schema

import { deserialize, serialize } from "josm-serializer"


let schema = {

  student: {
    name: "string",
    favColor: "color"
  },

  color: {
    r: "number",
    g: "number",
    b: "number"
  }

}

Populate data in schema fashion and serialize it.

Note that the case of the classes / tables (in this example student, color) must be the same as in the dataset

let color = {
  r: 255,
  g: 255,
  b: 255
}

let unserialized = {
  student: [
    {
      name: "Peter",
      favColor: color // pass by reference
    },
    {
      name: "Michael",
      favColor: color // pass by reference
    }
  ]
}


let serialized = serialize(unserialized, schema)

sendDataSomeWhere(JSON.stringify(serialized))

On your recieving end, deserialize

let serialized = JSON.parse(await getDataFromSomeWhere())

let unserialized = deserialize(serialized, schema)

Arrays

A list of values can be represented in your schema like so

let schema = {

  student: {
    favColors: "color[]"
  },

  color: {
    r: "number",
    g: "number",
    b: "number"
  }

}

And accordingly used

let red = {
  r: 255,
  g: 0,
  b: 0
}

let blue = {
  r: 0,
  g: 0,
  b: 255
}

let student = {
  favColors: [red, blue]
}

let store = {
  student: [
    student
  ],
  color: [
    red,
    blue
  ]
}

This can be serialized and deserialized just like above.

Contribute

All feedback is appreciated. Create a pull request or write an issue.