twos-complement-buffer
Copyright (c) 2018-2019 Rafael da Silva Rocha.
https://github.com/rochars/twos-complement-buffer
twos-complement-buffer is a module to encode and decode two's complement integers to and from byte buffers.
- MIT licensed
- Can be used where typed arrays can't
Install
npm install twos-complement-buffer
Use
Browser
Use the twos-complement-buffer.js file in the /dist folder:
<script src="twos-complement-buffer.js"></script>
<script>
let buffer = [];
let tcbParser = new TwosComplementBuffer(32);
tcbParser.pack(buffer, -2045);
console.log(buffer);
</script>
Or load it from the jsDelivr CDN:
<script src="https://cdn.jsdelivr.net/npm/twos-complement-buffer"></script>
Or load it from unpkg:
<script src="https://unpkg.com/twos-complement-buffer"></script>
Node
const TwosComplementBuffer = require('twos-complement-buffer');
let buffer = [];
let tcbParser = new TwosComplementBuffer(32);
tcbParser.pack(buffer, -2045);
console.log(buffer);
API
class TwosComplementBuffer {
constructor(bits) {
this.bits;
this.bytes;
}
pack(buffer, num, index=0) {}
unpack(buffer, index=0) {}
}
Contributing
twos-complement-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
twos-complement-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-2019 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.