Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryan-rowland/binary-schema
Blazing fast two-way serialization between JSON and binary.
https://github.com/ryan-rowland/binary-schema
Last synced: 11 days ago
JSON representation
Blazing fast two-way serialization between JSON and binary.
- Host: GitHub
- URL: https://github.com/ryan-rowland/binary-schema
- Owner: ryan-rowland
- Created: 2016-04-01T17:40:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-04-07T03:30:47.000Z (over 8 years ago)
- Last Synced: 2024-10-11T02:35:07.066Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-blazingly-fast - binary-schema - Blazing fast two-way serialization between JSON and binary. (JavaScript)
README
# binary-schema
Blazing fast two-way serialization between JSON and binary. Creates a payload
smaller than JSON by using a shared schema, and performs faster than JSON.parse
and JSON.stringify.
### Supported Types
Currently these data types are supported: **[utf8, ascii, int8, uint8,
int16, uint16, int32, uint32, float, double]**
Planned to support: **[array, object, boolean, number]**
Values can be denoted as nullable by appending a question mark: `{ title: 'ascii?' }`
# Example Usage
```js
import BinarySchema from 'binary-schema';
const characterSchema = new BinarySchema({
name: 'ascii',
title: 'ascii?',
race: 'uint8',
class: 'uint8',
maxHp: 'uint32'
});
const binary = characterSchema.pack({
name: 'osom',
race: 3,
class: 7,
maxHp: 3500
});
// binary ===
// binary.length === 13
const json = characterSchema.unpack(binary);
// json === { class: 7, maxHp: 3500, name: 'osom', race: 3 }
// JSON.stringify(json).length === 47
```
# Unpacking from an offset
If you're interpreting packets, it may be useful to start reading from
an offset. For instance, the first byte may contain a UInt8 representing the
type of packet you're receiving.
```js
const schemas = {
0x01: new BinarySchema({ direction: 'uint8' }), // Move
0x02: new BinarySchema({ enemyId: 'ascii' }) // Attack
};
socket.on('data', (message) => {
const commandId = message.readUInt8(0);
const body = schemas[commandId](message, 1);
})
```
# API
```js
class BinarySchema {
constructor(template) {
// Compiles pack and unpack methods from the template.
}
pack(json, offset) {
// Returns a new buffer containing the packed json.
// If offset is specified, [offset] number of undesignated bytes will
// precede the packed json (extending the length of the buffer).
}
unpack(buffer, offset) {
// Returns the json unpacked from the passed buffer.
// If offset is specified, unpack will begin reading from that offset.
}
}
```
# Benchmarks
###pack
###unpack
