ieee754-buffer

ieee754-buffer

Copyright (c) 2018 Rafael da Silva Rocha.
Copyright (c) 2013 DeNA Co., Ltd.
Copyright (c) 2010, Linden Research, Inc
https://github.com/rochars/ieee754-buffer

ieee754-buffer is a ES module to encode and decode IEEE 754 floats without typed arrays.

• MIT licensed
• Use it out of the box in the browser
• Use it out of the box in Node.js
• Use it out of the box with TypeScript
• UMD compatible with IE6+ and browsers that support ES3/ES5/ES6+
• Tested with 16-bit, 32-bit and 64-bit floats
• Tested against Python's struct module

Install

npm install ieee754-buffer

Use

Browser

Use ieee754-buffer.umd.js:

<script src="ieee754-buffer.umd.js"></script>
<script>
	var buffer = [];
	ieee754Buffer.pack(buffer, 0, 3.1415927410, 8, 23);
	console.log(buffer);
</script>

Or load it from the jsDelivr CDN:

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

Or load it from unpkg:

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

Browser compatibility

ieee754-buffer.umd.js is compatible with IE6+. Should work in all modern browsers that support ES3/ES5/ES6+.

Cross-browser tests powered by

Node

Import ieee754Buffer from ieee754-buffer:

import * as ieee754Buffer from 'ieee754-buffer';
let buffer = Uint8Array(4);
ieee754Buffer.pack(buffer, 0, 3.1415927410, 8, 23);
console.log(buffer);

Or import just what you need:

import {pack, unpack} from 'ieee754-buffer';
let buffer = []; // Use arrays or typed arrays
pack(buffer, 0, 3.1415927410, 8, 23)
console.log(buffer);

Or require:

const ieee754Buffer = require('ieee754-buffer');

About

• Overflows are rounded towards Infinity and -Infinity.
• NaN is packed as quiet NaN. Both quiet NaN and signaling NaN can be unpacked.
• Support packing and unpacking zero and negative zero.
• Support packing and unpacking Infinity and negative Infinity
• always little endian, use byte-data for a endianness-independent interface of this lib

API

/**
 * Pack a IEEE 754 floating point number.
 * Derived from typedarray.js by Linden Research, MIT License.
 * @see https://bitbucket.org/lindenlab/llsd/raw/7d2646cd3f9b4c806e73aebc4b32bd81e4047fdc/js/typedarray.js
 * @param {!Uint8Array|!Array<number>} buffer The buffer.
 * @param {number} index The index to write on the buffer.
 * @param {number} num The number.
 * @param {number} ebits The number of bits of the exponent.
 * @param {number} fbits The number of bits of the fraction.
 * @return {number} The next index to write on the buffer.
 */
function pack(buffer, index, num, ebits, fbits) {}

/**
 * Unpack a IEEE 754 floating point number.
 * Derived from IEEE754 by DeNA Co., Ltd., MIT License. 
 * Adapted to handle NaN. Should port the solution to the original repo.
 * @see https://github.com/kazuho/ieee754.js/blob/master/ieee754.js
 * @param {!Uint8Array|!Array<number>} buffer The buffer.
 * @param {number} index The index to read from the buffer.
 * @param {number} ebits The number of bits of the exponent.
 * @param {number} fbits The number of bits of the fraction.
 * @return {number} The floating point number.
 */
function unpack(buffer, index, ebits, fbits) {}

Contributing

ieee754-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

ieee754-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

Copyright (c) 2018 Rafael da Silva Rocha.
Copyright (c) 2013 DeNA Co., Ltd.
Copyright (c) 2010, Linden Research, Inc

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.