1npm i @hazae41/binary

Node Package 📦

Features

Current features

• 100% TypeScript and ESM
• No external dependencies
• Zero-copy reading and writing
• Rust-like patterns
• Unit-tested

Usage

Writable

1class MyObject implements Writable {
2
3  constructor(
4    readonly x: number,
5    readonly y: number
6  ) {}
7
8  sizeOrThrow() {
9    return 1 + 2
10  }
11
12  writeOrThrow(cursor: Cursor) {
13    cursor.writeUint8OrThrow(this.x)
14    cursor.writeUint16OrThrow(this.y)
15  }
16
17}

1const myobject = new MyObject(1, 515)
2const bytes = Writable.writeToBytesOrThrow(myobject) // Uint8Array([1, 2, 3])

Readable

1class MyObject {
2
3  constructor(
4    readonly x: number,
5    readonly y: number
6  ) {}
7
8  static readOrThrow(cursor: Cursor): MyObject {
9    const x = cursor.readUint8OrThrow()
10    const y = cursor.readUint16OrThrow()
11
12    return new MyObject(x, y)
13  }
14
15}

1const bytes = new Uint8Array([1, 2, 3])
2const myobject = Readable.readFromBytesOrThrow(MyObject, bytes) // MyObject(1, 515)

Opaque

This is a binary data type that just holds bytes, it can be used when a binary data type is required

1const bytes = new Uint8Array([1, 2, 3])
2const opaque = Readable.readFromBytesOrThrow(Opaque.Uncopied, bytes) // Opaque(Uint8Array([1, 2, 3]))
3const myobject = opaque.readIntoOrThrow(MyObject) // MyObject(1, 515)

1const myobject = new MyObject(1, 515)
2const opaque = Opaque.writeFromOrThrow(myobject) // Opaque.Copied(Uint8Array([1, 2, 3]))
3const bytes = Writable.writeToBytesOrThrow(opaque) // Uint8Array([1, 2, 3])