You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

53 lines
1.8 KiB

4 years ago
  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. [travis-image]: https://img.shields.io/travis/feross/ieee754/master.svg
  3. [travis-url]: https://travis-ci.org/feross/ieee754
  4. [npm-image]: https://img.shields.io/npm/v/ieee754.svg
  5. [npm-url]: https://npmjs.org/package/ieee754
  6. [downloads-image]: https://img.shields.io/npm/dm/ieee754.svg
  7. [downloads-url]: https://npmjs.org/package/ieee754
  8. [standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
  9. [standard-url]: https://standardjs.com
  10. [![saucelabs][saucelabs-image]][saucelabs-url]
  11. [saucelabs-image]: https://saucelabs.com/browser-matrix/ieee754.svg
  12. [saucelabs-url]: https://saucelabs.com/u/ieee754
  13. ### Read/write IEEE754 floating point numbers from/to a Buffer or array-like object.
  14. ## install
  15. ```
  16. npm install ieee754
  17. ```
  18. [Get supported ieee754 with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-ieee754?utm_source=npm-ieee754&utm_medium=referral&utm_campaign=readme)
  19. ## methods
  20. `var ieee754 = require('ieee754')`
  21. The `ieee754` object has the following functions:
  22. ```
  23. ieee754.read = function (buffer, offset, isLE, mLen, nBytes)
  24. ieee754.write = function (buffer, value, offset, isLE, mLen, nBytes)
  25. ```
  26. The arguments mean the following:
  27. - buffer = the buffer
  28. - offset = offset into the buffer
  29. - value = value to set (only for `write`)
  30. - isLe = is little endian?
  31. - mLen = mantissa length
  32. - nBytes = number of bytes
  33. ## what is ieee754?
  34. The 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).
  35. ## license
  36. BSD 3 Clause. Copyright (c) 2008, Fair Oaks Labs, Inc.