1.0.1 • Published 1 year ago

byffer.ts v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

byffer.ts

GitHub Actions Workflow Status NPM Version

An easy library to read and manipulate byte buffers in TypeScript.

It is also on npm here.

Installation

Installation is made easy with npm

npm install byffer.ts

Using byffer.ts

You can create a ByteBuf instance to store and read manipulate your data.

It can be created empty, or using pre-existing data.

Here's an example of using byffer.ts:

import ByteBuf from 'byffer.ts';

// Create an empty buffer with 128 bytes
let buf: ByteBuf = ByteBuf.emptyBuffer(128);
// or, use an existing ArrayBuffer like class (ArrayBufferLike)
buf = ByteBuf.from(awesome_buffer);

// You can then write some data
buf.writeInt(1337);
buf.writeByteUnsigned(255);
buf.writeByteString("I'm saying hi, from byffer!");
buf.writeFloat(-999999.3125);

// Then you can take back the data as an ArrayBuffer
let data: ArrayBuffer = buf.bytes();

// Or, read the data
let i = buf.readInt(); // Returns 1337
let b = buf.readByteUnsigned(); // Returns 255
let s = buf.readByteString(); // Returns "I'm saying hi, from byffer!"
let f = buf.readFloat(); // Returns -999999.3125

License

byffer.ts is licensed under the MIT license. You can do pretty much whatever you want to with this code.

1.0.1

1 year ago

1.0.0

1 year ago