@jsprismarine/jsbinaryutils
v5.5.3
Published
Basic binary data managing tool written in TypeScript.
Downloads
4,604
Readme
JSBinaryUtils
A TypeScript / JavaScript library for managing buffers in a NodeJS app. This library has been created to solve the big overhead of resources usage when a project needs to write some new data very often in the same Buffer instance (Buffer.concat will create new Buffers, so it's really bad for the performance of real time applications, and that is why JSBinaryUtils was created).
:warning: This guide is incomplete, please help by contributing! thank you :)
Installation
Install by npm
npm install @jsprismarine/jsbinaryutils
or install with yarn
yarn add @jsprismarine/jsbinaryutils
Api
A BinaryStream instance can be used for reading or for writing but not both at the same time.
Reading
read(length: number)
Reads a slice of bytes in the buffer on the stream instance and returns it in a Buffer.
Usage
import BinaryStream from "@jsprismarine/jsbinaryutils";
const stream = new BinaryStream(Buffer.from([255, 255, 200, 2]));
console.log(stream.read(4)); // Buffer < 0xFF 0xFF 0xFF 0xC8 0x02 >
readByte()
Reads an unsigned byte from the buffer (0 to 255).
Usage
import BinaryStream from "@jsprismarine/jsbinaryutils";
const stream = new BinaryStream(Buffer.from([0xFF]));
console.log(stream.readByte()); // 255
readSignedByte()
Reads a signed byte from the buffer (-128 to 127).
Usage
import BinaryStream from "@jsprismarine/jsbinaryutils";
const stream = new BinaryStream(Buffer.from([0x7F]));
console.log(stream.readSignedByte()); // 127
readBoolean()
Reads a boolean (1 byte, either true or false). Everything that is not 0x00 is true.
Usage
import BinaryStream from "@jsprismarine/jsbinaryutils";
const stream = new BinaryStream(Buffer.from([0x01]));
console.log(stream.readBoolean()); // true
readShort()
Reads a signed big-endian short (2 bytes).
readShortLE()
Reads a signed little-endian short (2 bytes).
readUnsignedShort()
Reads an unsigned big-endian short (2 bytes).
readUnsignedShortLE()
Reads an unsigned little-endian short (2 bytes).
readTriad()
Reads a big-endian triad (3 bytes).
readTriadLE()
Reads a little-endian triad (3 bytes).
readUnsignedTriad()
Reads an unsigned big-endian triad (3 bytes).
readUnsignedTriadLE()
Reads an unsigned little-endian triad (3 bytes).
readInt()
Reads a signed big-endian integer (1 byte, 0 to 255).
todo...
Writing
write(buffer: Uint8Array | Buffer)
Concatenates the given buffer with the stream instance one.
Usage
import BinaryStream from "@jsprismarine/jsbinaryutils";
const stream = new BinaryStream();
stream.write(Buffer.from([255, 255, 200, 2]));
console.log(stream.getBuffer()); // Buffer < 0xFF 0xFF 0xFF 0xC8 0x02 >