Package Exports

byte-data

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (byte-data) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

byte-data

Pack and unpack binary data.
Copyright (c) 2017-2018 Rafael da Silva Rocha.
https://github.com/rochars/byte-data

Runs in the server and in the browser
Less than 2KB minified + compressed, less than 5KB minified
Pack and unpack single values and entire buffers

Pack/unpack:

Integers, signed and unsigned
16-bit half-precision floating point numbers
32-bit single-precision floating point numbers
64-bit double-precision floating point numbers
Little-endian and big-endian words
Strings

Install

npm install byte-data

Use

ES6

import {pack} from 'byte-data.js';

// Pack a usigned 8-bit number
let packed = pack(128, {'bits': 8});

Node

const byteData = require('byte-data');

// Pack a float32 number
byteData.pack(2.1474836, {'bits': 32, 'float': true});
//[95, 112, 9, 64]

Browser

Use the compiled file in the /dist folder:

<script src="byte-data.min.js"></script>
<script>
  // Pack a float32 number
  byteData.pack(2.1474836, {'bits': 32, 'float': true});
  //[95, 112, 9, 64]
</script>

Or get it from the jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/byte-data@13"></script>

Or get it from unpkg:

<script src="https://unpkg.com/byte-data@13"></script>

Or as a ES6 module in modern browsers from jspm:

<script type="module">
  import {pack} from 'https://dev.jspm.io/byte-data';
  pack(-1200, {'bits': 16, 'signed': true});
</script>

Example

const byteData = require('byte-data');

// Pack a float32 number
byteData.pack(2.1474836, {'bits': 32, 'float': true});
//[95, 112, 9, 64]

// Pack an array of uInt16 numbers
byteData.packArray([65535, 0], {'bits': 16});
// [255, 255, 0, 0]);

// Pack an array of int32 numbers
byteData.packArray([-2147483648, 2147483647], {'bits': 32, 'signed': true});
//[0, 0, 0, 128, 255, 255, 255, 127]

// Unpack an array of uInt16 numbers
byteData.unpackArray([255, 255, 0, 0], {'bits': 16});
// [65535, 0]

API

Strings

/**
 * Read a string from a byte buffer.
 * @param {!Uint8Array} bytes A byte buffer.
 * @param {number=} index The index to read.
 * @param {?number=} len The number of bytes to read.
 * @return {string}
 */
function unpackString(bytes, index=0, len=null) {}

/**
 * Write a string as a byte buffer.
 * @param {string} str The string to pack.
 * @return {!Array<number>} The next index to write on the buffer.
 */
function packString(str) {}

/**
 * Write a string to a byte buffer.
 * @param {string} str The string to pack.
 * @param {!Uint8Array} bytes A byte buffer.
 * @param {number=} index The index to write in the buffer.
 * @return {number} The next index to write in the buffer.
 */
function packStringTo(str, bytes, index=0) {}

Numbers

/**
 * Pack a number as a byte buffer.
 * @param {number} value The number.
 * @param {!Object} theType The type definition.
 * @return {!Array<number>} The packed value.
 * @throws {Error} If the type definition is not valid.
 * @throws {Error} If the value is not valid.
 */
function pack(value, theType) {}

/**
 * Pack an array of numbers as a byte buffer.
 * @param {!Array<number>} values The values.
 * @param {!Object} theType The type definition.
 * @return {!Array<number>} The packed values.
 * @throws {Error} If the type definition is not valid.
 * @throws {Error} If any of the values are not valid.
 */
function packArray(values, theType) {}

/**
 * Pack a number to a byte buffer.
 * @param {number} value The value.
 * @param {!Object} theType The type definition.
 * @param {!Uint8Array} buffer The output buffer.
 * @param {number=} index The index to write.
 * @return {number} The next index to write.
 * @throws {Error} If the type definition is not valid.
 * @throws {Error} If the value is not valid.
 */
function packTo(value, theType, buffer, index=0) {}

/**
 * Pack a array of numbers to a byte buffer.
 * @param {!Array<number>} values The value.
 * @param {!Object} theType The type definition.
 * @param {!Uint8Array} buffer The output buffer.
 * @param {number=} index The buffer index to write.
 * @return {number} The next index to write.
 * @throws {Error} If the type definition is not valid.
 * @throws {Error} If the value is not valid.
 */
function packArrayTo(values, theType, buffer, index=0) {}

/**
 * Unpack a number from a byte buffer.
 * @param {!Uint8Array} buffer The byte buffer.
 * @param {!Object} theType The type definition.
 * @return {number}
 * @throws {Error} If the type definition is not valid
 */
function unpack(buffer, theType) {}

/**
 * Unpack an array of numbers from a byte buffer.
 * @param {!Uint8Array} buffer The byte buffer.
 * @param {!Object} theType The type definition.
 * @return {!Array<number>}
 * @throws {Error} If the type definition is not valid.
 */
function unpackArray(buffer, theType) {}

/**
 * Unpack a number from a byte buffer by index.
 * @param {!Uint8Array} buffer The byte buffer.
 * @param {!Object} theType The type definition.
 * @param {number=} index The buffer index to read.
 * @return {number}
 * @throws {Error} If the type definition is not valid
 */
function unpackFrom(buffer, theType, index=0) {}

/**
 * Unpack a array of numbers from a byte buffer by index.
 * @param {!Uint8Array} buffer The byte buffer.
 * @param {!Object} theType The type definition.
 * @param {number=} start The start index. Assumes 0.
 * @param {?number=} end The end index. Assumes the buffer length.
 * @return {!Array<number>}
 * @throws {Error} If the type definition is not valid
 */
function unpackArrayFrom(buffer, theType, start=0, end=null) {}

Floating-point numbers

Floating-point numbers are IEEE 754 standard.

Signed integers

Signed integers are two's complement.

Types

Types are user-defined objects like this:

const float32 = {
  "bits": 32, // required
  "signed": true, // optional, defaults to false
  "float": true, // optional, defaults to false
  "be": false // optional, defaults to false, true for big-endian
}

There is a standard set of types that can be installed:

npm install binary-data-types

All types in binary-data-types are supported by byte-data. They are:

int2
uInt2
int4
uInt4
int8
uInt8

little-endian

int16
uInt16
float16
int24
uInt24
int32
uInt32
float32
int40
uInt40
int48
uInt48
float64

big-endian:

int16BE
uInt16BE
float16BE
int24BE
uInt24BE
int32BE
uInt32BE
float32BE
int40BE
uInt40BE
int48BE
uInt48BE
float64BE

Distribution

This library is a ES6 module also distributed as a CommonJS module, UMD and a compiled script for browsers.

The CommonJS is the one used by Node. It is served in the "main" field of package.json
The UMD module is compatible with Node, AMD and browsers. It is served in the "browser" field.
The compiled dist is browser-only and should be the one served by CDNs.
The ES6 dist is byte-data.js, served as "module" in package.json

You may load both byte-data.umd.js and byte-data.min.js in the browser with <script> tags.

Contributing

byte-data 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

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

Code of conduct

This project adopt the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html as its code of conduct.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting rocha.rafaelsilva@gmail.com.

Legal

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.