Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weisrc/sirdez
Glorious Binary Serialization and Deserialization for TypeScript.
https://github.com/weisrc/sirdez
binary buffer decoding deno encoding ipc javascript marshalling messsage msgpack nodejs protocol rpc serdes serialization treeshakable typescript web
Last synced: 26 days ago
JSON representation
Glorious Binary Serialization and Deserialization for TypeScript.
- Host: GitHub
- URL: https://github.com/weisrc/sirdez
- Owner: weisrc
- License: mit
- Created: 2022-01-07T22:16:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-17T19:10:22.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T19:27:59.005Z (about 1 month ago)
- Topics: binary, buffer, decoding, deno, encoding, ipc, javascript, marshalling, messsage, msgpack, nodejs, protocol, rpc, serdes, serialization, treeshakable, typescript, web
- Language: TypeScript
- Homepage: https://weisrc.github.io/sirdez/
- Size: 2.82 MB
- Stars: 29
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Sir Dez][logo-badge]][logo-url]
# **Glorious [_SerDes_][serdes] for TypeScript**
The **library** you can rely on,
For **binary** **serialization** and **deserialization**,
In **Node**, **Deno**, and the **Web** environment,
Which is **simple** and yet **performant**.
[![npm][npm-badge]][npm-url]
[![deno][deno-badge]][deno-url]
[![ci][ci-badge]][ci-url]
[![coverage][coverage-badge]][coverage-url]
[![report][report-badge]][report-url]
[![docs][docs-badge]][docs-url]
[![perf][perf-badge]][perf-url]
[![bundle][bundle-badge]][bundle-url]
## Features
- Performant
- Easy to use
- Full TypeScript support
- Super extensible
- 99% tree-shakable
- Zero dependencies (small footprint)
- Runs in Node, Deno and browsers
- No `eval()` or `Function()` by default
- Performant eval mode with `import "sirdez/eval"`
- MessagePack for schemaless data
- [More details...][design-url]
**Performance Comparison with other tools in Node (ops/sec)**
[![performance][perf-chart]][perf-url]
## Installation
Expand for more details.
Node (with or without bundlers)
#### In the terminal with NPM
```sh
npm i sirdez
```
#### Or with Yarn
```sh
yarn add sirdez
```
#### In the code with ES Modules
```ts
import * as sd from "sirdez";
```
#### or with CommonJS
```ts
const sd = require("sirdez");
```
Web (without bundlers)
#### In HTML with UMD
```html
```
#### In an ES module script (statically)
```js
import * as sd from "https://cdn.jsdelivr.net/npm/sirdez/dist/sirdez.es.js";
```
#### In an ES module script (dynamically)
```js
const sd = await import(
"https://cdn.jsdelivr.net/npm/sirdez/dist/sirdez.es.js"
);
```
Deno
#### In code (statically)
```ts
import * as sd from "https://deno.land/x/sirdez/mod.ts";
```
#### In code (dynamically)
```ts
const sd = await import("https://deno.land/x/sirdez/mod.ts");
```
## Usage
#### Creating a simple SerDes.
```js
const person = sd.use(
sd.struct({
name: sd.string(sd.utf8, sd.uint8),
age: sd.uint8
})
);
const bytes = person.toBytes({
name: "Bob",
age: 23
});
const samePerson = person.fromBytes(bytes);
console.log({ bytes, samePerson });
```
#### Using TypeScript utilities
```ts
type Person = sd.GetType;
const bob: Person = {
name: "Bob",
age: 23
};
```
## Roadmap
- Support decorators for schema
- `msgpack` extension mechanism using classes
- Better support for protocol buffers
- Avro-Sirdez schema transpiler
## Known Issues
- `msgpack` becomes very slow for large arrays (help wanted for optimizing it! 🙏)
## Resources
- [Documentation][docs-url]
- [Coverage Report][coverage-url]
- [Test Report][report-url]
- [Performance Report][perf-url]
- [NPM package][npm-url]
- [Deno Land][deno-url]
- [GitHub Action CI][ci-url]
## Contribution
Help and suggestions are welcomed!
## License
Copyright 2022 Wei (weisrc).
This software is under the MIT license.
Please see [LICENSE][license-url] for more information.
[serdes]: https://en.wikipedia.org/wiki/SerDes
[logo-badge]: https://see.fontimg.com/api/renderfont4/Zd2J/eyJyIjoiZnMiLCJoIjoxMjAsImZnYyI6IiNEQzE0M0MiLCJ0IjoxfQ/U2lyIERleg/x.png
[logo-url]: https://weisrc.github.io/sirdez
[ci-badge]: https://github.com/weisrc/sirdez/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/weisrc/sirdez/actions/workflows/ci.yml
[npm-badge]: https://img.shields.io/npm/v/sirdez?color=cb3837&label=npm&logo=npm
[npm-url]: https://www.npmjs.com/package/sirdez
[deno-badge]: https://img.shields.io/github/v/release/weisrc/sirdez?color=white&include_prereleases&label=deno&logo=deno
[deno-url]: https://deno.land/x/sirdez
[coverage-badge]: https://img.shields.io/endpoint?url=https://weisrc.github.io/sirdez/badges/coverage.json
[coverage-url]: https://weisrc.github.io/sirdez/coverage/lcov-report
[report-badge]: https://img.shields.io/endpoint?url=https://weisrc.github.io/sirdez/badges/report.json
[report-url]: https://weisrc.github.io/sirdez/report
[perf-badge]: https://img.shields.io/endpoint?url=https://weisrc.github.io/sirdez/badges/perf.json
[perf-chart]: https://weisrc.github.io/sirdez/perf/main.png
[perf-url]: https://weisrc.github.io/sirdez/performance
[docs-badge]: https://img.shields.io/badge/docs-vuepress-41B883?logo=readthedocs
[docs-url]: https://weisrc.github.io/sirdez
[design-url]: https://weisrc.github.io/sirdez/design
[bundle-badge]: https://img.shields.io/bundlephobia/minzip/sirdez
[bundle-url]: https://bundlephobia.com/package/sirdez
[license-url]: https://github.com/weisrc/sirdez/blob/main/LICENSE