json-as

AS-JSON

Installation

~ npm install json-as

~ npm install visitor-as

For arbitrary-length numbers, use

~ npm install as-bignum

Add the transform to your asc command

--transform json-as/transform

Or, add it to asconfig.json

{
  "options": {
    "transform": ["json-as/transform"]
  }
}

Usage

import { JSON } from "json-as/assembly";

// @ts-ignore
@json
class Vec3 {
  x!: f32;
  y!: f32;
  z!: f32;
}

// @ts-ignore
@json
class Player {
  firstName!: string;
  lastName!: string;
  lastActive!: i32[];
  age!: i32;
  pos!: Vec3 | null;
  isVerified!: boolean;
}

const player: Player = {
  firstName: "Emmet",
  lastName: "West",
  lastActive: [8, 27, 2022],
  age: 23,
  pos: {
    x: 3.4,
    y: 1.2,
    z: 8.3
  },
  isVerified: true
};

const stringified = JSON.stringify<Player>(player);

const parsed = JSON.parse<Player>(stringified);

FAQ

Does it support the JSON specification?

Yes, it does. However, dynamic objects and arrays are not supported, but planned in the near future.

Is it fast?

Look below

How does it compare to other libs?

Its pretty much the same as the other libraries out there (near/assemblyscript-json and @serial-as/json), but it focuses highly on performance

Will it catch invalid JSON?

No, it does not check for invalid JSON, but gives its best shot at parsing instead. Will probably throw an error.

How does it compare performance-wise to other libraries?

In my testing, parsing a Vector 2 runs at 2.2m ops/s with as-json and around 10,000 ops/s with assemblyscript-json and @serial-as/json. Both are great libraries however.

Performance

Serialize Object (Vec2): ~7.20m ops/s

Deserialize Object (Vec2): ~2.2m ops/s

Serialize Array (int[4]): ~1.4m ops/s

Deserialize Array (int[4]): ~2.8m ops/s

Serialize String (5): ~5.2m ops/sw

Deserialize String (5): ~1.36m ops/s

Issues

Please submit an issue to https://github.com/JairusSW/as-json/issues if you find anything wrong with this library