Bytes

Utilities to deal with sized Uint8Array

1npm i @hazae41/bytes

Node Package 📦

Features

• 100% TypeScript and ESM
• Rust-like patterns
• Strongly typed Uint8Array and ArrayLike size
• Zero-cost abstraction over Uint8Array and ArrayLike
• Zero-copy conversion from ArrayBufferView
• Use native Buffer for faster execution on Node
• Unit-tested

Usage

Sized bytes

1const bytes8 = Bytes.alloc(8) // Bytes<8>

Unsafe-allocated sized bytes

1const bytes8 = Bytes.allocUnsafe(8) // Bytes<8>

Random sized bytes

1const bytes8 = Bytes.random(8) // Bytes<8>

Unknown-sized bytes

1const bytesX = new Uint8Array(8) // Bytes<number>

Runtime type-guarding

1if (Bytes.is(bytesX, 8))
2  bytesX // Bytes<8>
3else
4  bytesX // Bytes<number>

Type-guarded runtime equality check

1if (Bytes.equals(bytesX, bytes8))
2  bytesX // Bytes<8>
3else
4  bytesX // Bytes<number>

Runtime casting with Result pattern

1const bytes16 = Bytes.tryCast(bytesX, 16).unwrap() // Bytes<16>

Conversion from sized arrays

1const sized4 = Sized.cast([1, 2, 3, 4], 4).unwrap() // Sized<4>
2const bytes4 = Bytes.from(sized4) // Bytes<4>

Utf8, Hex, Base64, Ascii encoding

1Bytes.fromUtf8(Bytes.toUtf8(bytesX))

1Bytes.fromHex(Bytes.toHex(bytesX))

1Bytes.fromBase64(Bytes.toBase64(bytesX))

1Bytes.fromAscii(Bytes.toAscii(bytesX))

BigInt conversion

1Bytes.fromBigInt(Bytes.toBigInt(bytesX))

Sized slicing and padding

1const bytes8 = Bytes.sliceOrPadStart(bytesX, 8) // Bytes<8>