endianness

endianness

Copyright (c) 2017-2018 Rafael da Silva Rocha.
https://github.com/rochars/endianness

Swap endianness in byte arrays. The input buffer is modified in-place.

• Works everywhere, server and browser
• Works with any byte offset
• Can swap only a part of the buffer

Install

npm install endianness

Use

ES6

import endianness from ./dist/endianness.js:

import endianness from './dist/endianness.js';

// Swap endianness of one 64-bit value:
let bytes = [64, 9, 33, 251, 84, 68, 45, 24];
endianness(bytes, 8);

Node

require endianness:

const endianness = require("endianness");

// Swap endianness of two 24-bit values:
let bytes = new Uint8Array(["00", "00", "80", "ff", "ff", "7f"]);
endianness(bytes, 3),

Browser

Use endianness.min.js from the dist/ folder:

<script src="./dist/endianness.min.js"></script>
<script>
    var bytes = [64, 9, 33, 251, 84, 68, 45, 24]; 
    endianness(bytes, 8);
    console.log(bytes);
</script>

Or get it from the jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/endianness"></script>

Or get it from unpkg:

<script src="https://unpkg.com/endianness"></script>

Or as a ES6 module for modern browsers from jspm:

<script type="module">
	import endianness from 'https://dev.jspm.io/endianness';
</script>

API

/**
 * Swap the byte ordering in a buffer. The buffer is modified in place.
 * @param {!Array<number|string>|!Uint8Array} bytes The bytes.
 * @param {number} offset The byte offset.
 * @param {number=} start The start index. Assumes 0.
 * @param {?number=} end The end index. Assumes the buffer length.
 * @throws {Error} If the buffer length is not valid.
 */
function endianness(bytes, offset, start=0, end=null) {}

Distribution

This library is a ES module also distributed as a CommonJS module, UMD module and a compiled script for browsers. It works out of the box in Node when installed with npm install endianness. It includes a TypeScript definition file.

If you use the Closure Compiler, this package includes a externs file: ./externs.js.

If you are using this lib in a browser:

You may load both ./dist/endianness.umd.js and ./dist/endianness.min.js in the browser with <script> tags. Ideally you should use endianness.min.js. You can load it via the https://unpkg.com and https://www.jsdelivr.com/ CDNs:

unpkg:

<script src="https://unpkg.com/endianness"></script>

jsDelivr:

<script src="https://cdn.jsdelivr.net/npm/endianness"></script>

If you are using this lib as a dependency:

• The CommonJS is the dist file used by Node. It is served in the "main" field of package.json. This is the source you are running when you npm install endianness.

• The UMD module is compatible with Node, AMD and browsers. It is served in the "browser" field of package.json. This file is not compiled/minified as it may be used by module bundlers. Compilation/minification should be up to the bundler consuming this file.

• The compiled dist is browser-only and should be the one served by CDNs. It is used in the "unpkg" and "jsdelivr" fields of package.json.

• The ES6 dist is ./dist/endianness.js, served as "es2015" in package.json. It is not compiled/minified.

• ./index.js is served as "module" in package.json. This should be the entry point for bundlers.

If your module bundler is using "browser" as the entry point your dist should work the same but will be a larger file.

LICENSE

Copyright (c) 2017-2018 Rafael da Silva Rocha.

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.