A set of utility classes for reading and writing binary data in NodeJS.
Go to file
Holly Stubbs ceffc3eb87 Update README.md 2024-05-01 11:42:22 +01:00
.github/workflows Add browser js support 2023-10-24 12:04:32 +01:00
base Add functions for reading/writing strings without lengths 2024-01-01 22:23:16 +00:00
readers Add functions for reading/writing strings without lengths 2024-01-01 22:23:16 +00:00
tooling Add browser js support 2023-10-24 12:04:32 +01:00
writers Add functions for reading/writing strings without lengths 2024-01-01 22:23:16 +00:00
.gitignore janky tooling to get this working properly 2023-06-22 11:32:40 +01:00
.npmignore npmignore the base folder 2023-10-24 12:15:45 +01:00
LICENSE update LICENSE 2024-01-01 22:35:13 +00:00
README.md Update README.md 2024-05-01 11:42:22 +01:00
index.ts Add license header everywhere 2023-10-24 12:04:07 +01:00
package-lock.json Update dev depends 2024-01-19 10:38:56 +00:00
package.json Update dev depends 2024-01-19 10:38:56 +00:00
tsconfig.json Bump to es2020 2023-10-24 12:04:16 +01:00

README.md

bufferStuff   CodeFactor   Node.js CI   npm

A set of utility classes for reading and writing binary data in NodeJS.

Motivations

I tend to write code a lot that needs to read and write from buffers and this is sometimes in big-endian too, so I decided eventually to make a utility to help me with that which is what you see here. Originally I had two variants of bufferStuff that were for LE and BE respectively but this got difficult to manage so I rewrote it in TypeScript and added support for both reader / writer types.

Usage

You can create an instance of the Reader and Writer classes like this:

// You *must* be expicit with the endianness
const leReader:IReader = createReader(Endian.LE, buffer);
const beReader:IReader = createReader(Endian.BE, buffer);

// Size is optional, will dynamically allocate if left empty or 0
const leWriter:IWriter = createWriter(Endian.LE, <optional: size>);
const beWriter:IWriter = createWriter(Endian.BE, <optional: size>);

I tried to keep it as simple as possible to use, for example if you want to write a (signed) byte you do as follows:

writer.writeByte(<number>);

You can find a list of all of the methods for Writers and Readers in their interface files.

Projects using bufferStuff

If your project uses bufferStuff feel free to make a PR to add it to this list!

tgpholly/mc-beta-server

tgpholly/ultrakillMP_server

tgpholly/t00-multiuser

Projects similar to bufferStuff

tgpholly/csharp-extensions/BinaryTools - Basically bufferStuff but for C#