UNPKG

1.65 kBMarkdownView Raw
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## methods
26
27`var ieee754 = require('ieee754')`
28
29The `ieee754` object has the following functions:
30
31```
32ieee754.read = function (buffer, offset, isLE, mLen, nBytes)
33ieee754.write = function (buffer, value, offset, isLE, mLen, nBytes)
34```
35
36The arguments mean the following:
37
38- buffer = the buffer
39- offset = offset into the buffer
40- value = value to set (only for `write`)
41- isLe = is little endian?
42- mLen = mantissa length
43- nBytes = number of bytes
44
45## what is ieee754?
46
47The 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).
48
49## license
50
51BSD 3 Clause. Copyright (c) 2008, Fair Oaks Labs, Inc.