README

uint-buffer

uint-buffer is a module to encode and decode unsigned integers to and from byte buffers.

MIT licensed
Can be used where typed arrays can't

Install

npm install uint-buffer

Use

Browser

Use the uint-buffer.js file in the dist folder:

<script src="uint-buffer.js"></script>
<script>
  // A byte buffer, array and Uint8Array can be used
  var buffer = [];

  // Create a UintBuffer to handle 16-bit numbers
  var uintBufer = new UintBuffer.UintBuffer(16);

  // Pack a value
  uintBufer.pack(buffer, 767);

  // Check the buffer
  console.log(buffer);
</script>

Or load it from the jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/uint-buffer"></script>

Or load it from unpkg:

<script src="https://unpkg.com/uint-buffer"></script>

Node.js

const UintBuffer = require('uint-buffer').UintBuffer;

// A byte buffer, array and Uint8Array can be used
let buffer = [];

// Create a UintBuffer to handle 32-bit numbers
let uintBufer = new UintBuffer(32);

// Pack a value
uintBufer.pack(buffer, 2045);

// Check the buffer
console.log(buffer);

API

/**
 * A class to write and read unsigned ints to and from byte buffers.
 */
export class UintBuffer {
  
  /**
   * @param {number} bits The number of bits used by the integer.
   */
  constructor(bits) {
    /**
     * The number of bits used by one number.
     * @type {number}
     */
    this.bits;
    /**
     * The number of bytes used by one number.
     * @type {number}
     */
    this.bytes;
  }

  /**
   * Write one unsigned integer to a byte buffer.
   * @param {!Uint8Array|!Array<number>} buffer An array of bytes.
   * @param {number} num The number.
   * @param {number=} index The index being written in the byte buffer.
   * @return {number} The next index to write on the byte buffer.
   * @throws {TypeError} If num is not a number.
   * @throws {RangeError} On overflow.
   */
  pack(buffer, num, index=0) {}
  
  /**
   * Unpack one unsigned integer from a byte buffer.
   * @param {!Uint8Array|!Array<number>} buffer An array of bytes.
   * @param {number=} index The index to read.
   * @return {number} The number.
   * @throws {RangeError} On overflow.
   */
  unpack(buffer, index=0) {}

  /**
   * Write one unsigned integer to a byte buffer.
   * This method assumes the input has already been validated
   * and should be used only if you know what you are doing.
   * @param {!Uint8Array|!Array<number>} buffer An array of bytes.
   * @param {number} num The number.
   * @param {number=} index The index being written in the byte buffer.
   * @return {number} The next index to write on the byte buffer.
   */
  packUnsafe(buffer, num, index=0) {}

  /**
   * Read one unsigned integer from a byte buffer.
   * Does not check for overflows.
   * @param {!Uint8Array|!Array<number>} buffer An array of bytes.
   * @param {number=} index The index to read.
   * @return {number}
   */
  unpackUnsafe(buffer, index=0) {
    /** @type {number} */
    let num = 0;
    for(let x = 0; x < this.bytes; x++) {
      num += buffer[index + x] * Math.pow(256, x);
    }
    return num;
  }
}

Contributing

uint-buffer welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.

See CONTRIBUTING.md for details.

Style guide

uint-buffer code should follow the Google JavaScript Style Guide:
https://google.github.io/styleguide/jsguide.html

Code of conduct

This project is bound by a code of conduct: The Contributor Covenant, version 1.4, also available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!