Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JairusSW/as-json
JSON serialization/deserialization for AssemblyScript
https://github.com/JairusSW/as-json
assemblyscript json parse serialize stringify
Last synced: 3 months ago
JSON representation
JSON serialization/deserialization for AssemblyScript
- Host: GitHub
- URL: https://github.com/JairusSW/as-json
- Owner: JairusSW
- License: mit
- Created: 2021-05-13T16:47:41.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T00:04:05.000Z (3 months ago)
- Last Synced: 2024-04-03T06:56:02.675Z (3 months ago)
- Topics: assemblyscript, json, parse, serialize, stringify
- Language: TypeScript
- Homepage:
- Size: 1.16 MB
- Stars: 61
- Watchers: 3
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-list - as-json
- awesome-assemblyscript - JairusSW/as-json - JSON implementation (Packages)
README
JSON
## Installation
```bash
npm install json-as
```
Add the transform to your `asc` command (e.g. in package.json)
```bash
--transform json-as/transform
```
Alternatively, add it to your `asconfig.json`
```
{
// ...
"options": {
"transform": ["json-as/transform"]
}
}
```
## Usage
```js
import { JSON } from "json-as/assembly";
// @json or @serializable work here
@json
class Vec3 {
x!: f32;
y!: f32;
z!: f32;
}
@json
class Player {
@alias("first name")
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, true);
// You can toggle on setting default values with the 2nd parameter
// Alternative: use JSON.serializeTo(player, out);
const parsed = JSON.parse(stringified);
```
If you use this project in your codebase, consider dropping a [star](https://github.com/JairusSW/as-json). I would really appreciate it!
## Performance
Run or view the benchmarks [here](https://github.com/JairusSW/as-json/tree/master/bench)
Below are benchmark results comparing JavaScript, WAVM (WebAssembly Virtual Machine), and Wasmtime environments.
JavaScript Results
NodeJS v20.5.1 - TinyBench v2.5.0 (V8)
```
┌───────────────────────────┬───────────────┐
│ Task Name │ ops / sec │
├───────────────────────────┼───────────────┤
│ 'Stringify Object (Vec3)' │ '1,191,221' │
│ 'Parse Object (Vec3)' │ '897,759' │
│ 'Stringify Number Array' │ '1,552,255' │
│ 'Parse Number Array' │ '1,225,325' │
│ 'Stringify String' │ '1,761,011' │
│ 'Parse String' │ '80,845' │
└───────────────────────────┴───────────────┘
```
AssemblyScript Results
WAVM v0.0.0-prerelease - as-bench v0.0.0-alpha (LLVM)
```
┌───────────────────────────┬───────────────┐
│ Task Name │ ops / sec │
├───────────────────────────┼───────────────┤
│ 'Stringify Object (Vec3)' │ '6,270,322' │
│ 'Parse Object (Vec3)' │ '8,000,195' |
│ 'Stringify Number Array' │ '6,664,937' │
│ 'Parse Number Array' │ '6,557,357' │
│ 'Stringify String' │ '6,946,947' │
│ 'Parse String' │ '10,952,502' │
└───────────────────────────┴───────────────┘
```
Wasmtime v11.0.1 - as-bench v0.0.0-alpha (Cranelift)
```
┌───────────────────────────┬───────────────┐
│ Task Name │ ops / sec │
├───────────────────────────┼───────────────┤
│ 'Stringify Object (Vec3)' │ '2,038,684' │
│ 'Parse Object (Vec3)' │ '4,623,337' |
│ 'Stringify Number Array' │ '2,500,947' │
│ 'Parse Number Array' │ '2,959,180' │
│ 'Stringify String' │ '3,236,896' │
│ 'Parse String' │ '5,634,594' │
└───────────────────────────┴───────────────┘
```
## Issues
Please submit an issue to https://github.com/JairusSW/as-json/issues if you find anything wrong with this library