104 lines
4.3 KiB
Markdown
104 lines
4.3 KiB
Markdown
# endianness
|
|
Copyright (c) 2017-2018 Rafael da Silva Rocha.
|
|
https://github.com/rochars/endianness
|
|
|
|
[](https://www.npmjs.com/package/endianness) [](https://rochars.github.io/endianness/docs/index.html) [](https://rochars.github.io/endianness/test/dist/browser.html)
|
|
[](https://codecov.io/gh/rochars/endianness) [](https://travis-ci.org/rochars/endianness) [](https://ci.appveyor.com/project/rochars/endianness) [](https://scrutinizer-ci.com/g/rochars/endianness/)
|
|
|
|
Swap endianness in byte arrays. The input buffer is modified in place.
|
|
|
|
- **MIT licensed**
|
|
- **Compatible with IE6+ and browsers that support ES3/ES5/ES6+**
|
|
- **Use it out of the box in Node.js**
|
|
- **Use it out of the box with [TypeScript](https://www.typescriptlang.org/)**
|
|
- **Use it with any byte offset**
|
|
- **Swap entire buffers**
|
|
- **Swap only a slice of the buffer**
|
|
|
|
## Install
|
|
```
|
|
npm install endianness
|
|
```
|
|
|
|
## Use
|
|
|
|
### Browser
|
|
Use **endianness.umd.js**:
|
|
```html
|
|
<script src="endianness.umd.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](https://www.jsdelivr.com/npm/endianness) CDN:
|
|
```html
|
|
<script src="https://cdn.jsdelivr.net/npm/endianness"></script>
|
|
```
|
|
|
|
Or get it from [unpkg](https://www.unpkg.com/endianness):
|
|
```html
|
|
<script src="https://unpkg.com/endianness"></script>
|
|
```
|
|
|
|
#### Browser compatibility
|
|
**endianness.umd.js** is transpiled to ES3 and compatible with IE6+. Should work in all modern browsers that support ES3/ES5/ES6+.
|
|
|
|
Cross-browser tests powered by
|
|
<a href="https://www.browserstack.com"><img src="https://rochars.github.io/endianness/docs/Browserstack-logo@2x.png" width="150px"/></a>
|
|
|
|
### Node
|
|
Require or import **endianness** from **endianness**:
|
|
```javascript
|
|
import endianness from 'endianness';
|
|
|
|
// Swap endianness of one 64-bit value:
|
|
let bytes = [64, 9, 33, 251, 84, 68, 45, 24];
|
|
endianness(bytes, 8);
|
|
```
|
|
|
|
```javascript
|
|
const endianness = require("endianness");
|
|
|
|
// Swap endianness of two 24-bit values:
|
|
let bytes = new Uint8Array(["00", "00", "80", "ff", "ff", "7f"]);
|
|
endianness(bytes, 3),
|
|
```
|
|
|
|
## API
|
|
```javascript
|
|
/**
|
|
* 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=} index 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, index=0, end=bytes.length) {}
|
|
```
|
|
|
|
## 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.
|