Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.56 KB

README.md

File metadata and controls

57 lines (37 loc) · 1.56 KB
Raw

Sia Schema Compiler

A schema compiler for the fastest serializing library.

Don't know what Sia is? Check out the Github repo.

⚠️ This project is still in the early stages of development. Check the roadmap for more information.

Installation

npm install -g sia-schema

Or using npx:

npx sia-schema compile sample.sia

Add the --help flag to see the available options.

Why a schema compiler?

Sia is a fast serializing library that is used to serialize and deserialize data. It is designed to be used in scenarios where performance is critical, such as in real-time systems or in distributed systems.

However, the library's API is quite raw, and requires some previous knowledge of its API to get even the most basic data types serialized/deserialized.

Check this example:

new Sia().addString32("Andrey").addUInt32(25).addString32("[email protected]")
  .content;

Now, imagine you have to do this for every single type, having to deal with nested types, arrays, etc. That's where this schema compiler comes to help.

Usage

First, you need a schema:

schema Person {
  name    text
  age?    int32(min = 0, max = 120)
  email?  text(encoding = "ascii")
}

This will generate the exact same code as above.

Work in progress

  • Generate JavaScript code from the intermediate representation
  • Generate TypeScript code from the intermediate representation
  • Generate Python code from the intermediate representation
  • Add support for functions