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.

119 lines
3.7 KiB

  1. # utf8.js [![Build status](https://travis-ci.org/mathiasbynens/utf8.js.png?branch=master)](https://travis-ci.org/mathiasbynens/utf8.js) [![Dependency status](https://gemnasium.com/mathiasbynens/utf8.js.png)](https://gemnasium.com/mathiasbynens/utf8.js)
  2. _utf8.js_ is a well-tested UTF-8 encoder/decoder written in JavaScript. Unlike many other JavaScript solutions, it is designed to be a _proper_ UTF-8 encoder/decoder: it can encode/decode any given Unicode code point, including astral symbols and unpaired surrogates.
  3. Feel free to fork if you see possible improvements!
  4. ## Installation
  5. Via [npm](http://npmjs.org/):
  6. ```bash
  7. npm install utf8
  8. ```
  9. Via [Bower](http://bower.io/):
  10. ```bash
  11. bower install utf8
  12. ```
  13. Via [Component](https://github.com/component/component):
  14. ```bash
  15. component install mathiasbynens/utf8.js
  16. ```
  17. In a browser:
  18. ```html
  19. <script src="utf8.js"></script>
  20. ```
  21. In [Narwhal](http://narwhaljs.org/), [Node.js](http://nodejs.org/), and [RingoJS ≥ v0.8.0](http://ringojs.org/):
  22. ```js
  23. var utf8 = require('utf8');
  24. ```
  25. In [Rhino](http://www.mozilla.org/rhino/):
  26. ```js
  27. load('utf8.js');
  28. ```
  29. Using an AMD loader like [RequireJS](http://requirejs.org/):
  30. ```js
  31. require(
  32. {
  33. 'paths': {
  34. 'utf8': 'path/to/utf8'
  35. }
  36. },
  37. ['utf8'],
  38. function(utf8) {
  39. console.log(utf8);
  40. }
  41. );
  42. ```
  43. ## API
  44. ### `utf8.encode(string)`
  45. Encodes any given JavaScript string (`string`) as UTF-8, and returns the UTF-8-encoded version of the string.
  46. ```js
  47. // U+00A9 COPYRIGHT SIGN; see http://codepoints.net/U+00A9
  48. utf8.encode('\xA9');
  49. // → '\xC2\xA9'
  50. // U+10001 LINEAR B SYLLABLE B038 E; see http://codepoints.net/U+10001
  51. utf8.encode('\uD800\uDC01');
  52. // → '\xF0\x90\x80\x81'
  53. ```
  54. ### `utf8.decode(byteString)`
  55. Encodes any given UTF-8-encoded string (`byteString`) as UTF-8, and returns the UTF-8-decoded version of the string. It throws an error when malformed UTF-8 is detected.
  56. ```js
  57. utf8.decode('\xC2\xA9');
  58. // → '\xA9'
  59. utf8.decode('\xF0\x90\x80\x81');
  60. // → '\uD800\uDC01'
  61. // → U+10001 LINEAR B SYLLABLE B038 E
  62. ```
  63. ### `utf8.version`
  64. A string representing the semantic version number.
  65. ## Support
  66. utf8.js has been tested in at least Chrome 27-29, Firefox 3-22, Safari 4-6, Opera 10-12, IE 6-10, Node.js v0.10.0, Narwhal 0.3.2, RingoJS 0.8-0.9, PhantomJS 1.9.0, and Rhino 1.7RC4.
  67. ## Unit tests & code coverage
  68. After cloning this repository, run `npm install` to install the dependencies needed for development and testing. You may want to install Istanbul _globally_ using `npm install istanbul -g`.
  69. Once that’s done, you can run the unit tests in Node using `npm test` or `node tests/tests.js`. To run the tests in Rhino, Ringo, Narwhal, PhantomJS, and web browsers as well, use `grunt test`.
  70. To generate [the code coverage report](http://rawgithub.com/mathiasbynens/utf8.js/master/coverage/utf8.js/utf8.js.html), use `grunt cover`.
  71. ## FAQ
  72. ### Why is the first release named v2.0.0? Haven’t you heard of [semantic versioning](http://semver.org/)?
  73. Long before utf8.js was created, the `utf8` module on npm was registered and used by another (slightly buggy) library. @ryanmcgrath was kind enough to give me access to the `utf8` package on npm when I told him about utf8.js. Since there has already been a v1.0.0 release of the old library, and to avoid breaking backwards compatibility with projects that rely on the `utf8` npm package, I decided the tag the first release of utf8.js as v2.0.0 and take it from there.
  74. ## Author
  75. | [![twitter/mathias](http://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](http://twitter.com/mathias "Follow @mathias on Twitter") |
  76. |---|
  77. | [Mathias Bynens](http://mathiasbynens.be/) |
  78. ## License
  79. utf8.js is dual licensed under the [MIT](http://mths.be/mit) and [GPL](http://mths.be/gpl) licenses.