# josm-serializer

> Searializer and deserializer for josm.

Latest version **1.0.0** (published 2020-03-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install josm-serializer
pnpm add josm-serializer
yarn add josm-serializer
bun add josm-serializer
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-03-26 |
| First published | 2020-03-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 82.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Maximilian Mairinger |
| Maintainers | zzrv |
| Keywords | josm, serializer |

## Links

- npm: https://www.npmjs.com/package/josm-serializer
- Repository: https://github.com/maximilianMairinger/josmSerializer
- Homepage: https://github.com/maximilianMairinger/josmSerializer#readme
- Issues: https://github.com/maximilianMairinger/josmSerializer/issues
- npm.io page: https://npm.io/package/josm-serializer

## Dependencies (1)

- [xrray](https://npm.io/package/xrray.md) ^4.6.4

## Recent versions

- 1.0.0 (latest) — 2020-03-26
- 0.0.1 — 2020-03-24

## README

# 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

```ts
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

```ts
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

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

let unserialized = deserialize(serialized, schema)
```

### Arrays

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

```ts
let schema = {

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

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

}
```

And accordingly used

```ts
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.

---
_Source: https://npm.io/package/josm-serializer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._