@minecraft-js/bufwrapper

BufWrapper

Encode and decode data using buffers

Features

Encode and decode:

• Varint
• String
• Int
• Long
• Array of strings
• Array of ints
• UUID
• Byte
• Boolean
• Float
• Short
• Double

⚠️ They are all signed and big endian (As Java does)

Documentation

Installation

Install the package:

$ npm install @minecraft-js/bufwrapper

And then import it in your JavaScript/TypeScript file

const { BufWrapper } = require('@minecraft-js/bufwrapper'); // CommonJS

import { BufWrapper } from '@minecraft-js/bufwrapper'; // ES6

Writing a buffer

First, instantiate a new BufWrapper

const buf = new BufWrapper();

And then you can use any method to write data into it

buf.writeInt(42);
buf.writeString('Hello World');
buf.writeLong(123456789);

Reading a buffer

To read a buffer content, you need to instantiate a new BufWrapper and pass the buffer to the constructor

// Buffer with dummy data
const buffer = Buffer.from(
  '0000002a0b48656c6c6f20576f726c6400000000075bcd15',
  'hex'
);

const buf = new BufWrapper(buffer);
buf.readInt(); // 42
buf.readString(); // 'Hello World'
buf.readLong(); // 123456789

Note on the speed

By default the library can be slow if you are writing a lot of data. The writing process can be optimized by using the oneConcat option.

This option requires an additional call after writing the data.

const buf = new BufWrapper(null, { oneConcat: true });
buf.writeInt(42);
buf.writeString('Hello World');
buf.writeLong(123456789);

// The call required
buf.finish();

Before you call the BufWrapper#finish method, the BufWrapper#buffer property will be an empty buffer.

You can see by yourself the speed upgrade by running the test/time.js file. Here is what I got on my computer when writing 150,000 integers

$ node test/time.js
oneConcat = false : 7.261s
oneConcat = true  : 63.869ms

See more here: https://minecraftjs.github.io/BufWrapper/