README.md
1# ieee754 [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
2
3[travis-image]: https://img.shields.io/travis/feross/ieee754/master.svg
4[travis-url]: https://travis-ci.org/feross/ieee754
5[npm-image]: https://img.shields.io/npm/v/ieee754.svg
6[npm-url]: https://npmjs.org/package/ieee754
7[downloads-image]: https://img.shields.io/npm/dm/ieee754.svg
8[downloads-url]: https://npmjs.org/package/ieee754
9[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
10[standard-url]: https://standardjs.com
11
12[![saucelabs][saucelabs-image]][saucelabs-url]
13
14[saucelabs-image]: https://saucelabs.com/browser-matrix/ieee754.svg
15[saucelabs-url]: https://saucelabs.com/u/ieee754
16
17### Read/write IEEE754 floating point numbers from/to a Buffer or array-like object.
18
19## install
20
21```
22npm install ieee754
23```
24
25[Get supported ieee754 with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-ieee754?utm_source=npm-ieee754&utm_medium=referral&utm_campaign=readme)
26
27## methods
28
29`var ieee754 = require('ieee754')`
30
31The `ieee754` object has the following functions:
32
33```
34ieee754.read = function (buffer, offset, isLE, mLen, nBytes)
35ieee754.write = function (buffer, value, offset, isLE, mLen, nBytes)
36```
37
38The arguments mean the following:
39
40- buffer = the buffer
41- offset = offset into the buffer
42- value = value to set (only for `write`)
43- isLe = is little endian?
44- mLen = mantissa length
45- nBytes = number of bytes
46
47## what is ieee754?
48
49The IEEE Standard for Floating-Point Arithmetic (IEEE 754) is a technical standard for floating-point computation. [Read more](http://en.wikipedia.org/wiki/IEEE_floating_point).
50
51## license
52
53BSD 3 Clause. Copyright (c) 2008, Fair Oaks Labs, Inc.
54
