|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- ## Pure JS character encoding conversion
-
- <!-- [![Build Status](https://secure.travis-ci.org/ashtuchkin/iconv-lite.png?branch=master)](http://travis-ci.org/ashtuchkin/iconv-lite) -->
-
- * Doesn't need native code compilation. Works on Windows and in sandboxed environments like [Cloud9](http://c9.io).
- * Used in popular projects like [Grunt](http://gruntjs.com/), [Nodemailer](http://www.nodemailer.com/), [Yeoman](http://yeoman.io/) and others.
- * Faster than [node-iconv](https://github.com/bnoordhuis/node-iconv) (see below for performance comparison).
- * Intuitive encode/decode API
- * Streaming support for Node v0.10+
- * Can extend Node.js primitives (buffers, streams) to support all iconv-lite encodings.
- * In-browser usage via [Browserify](https://github.com/substack/node-browserify) (~180k gzip compressed with Buffer shim included).
- * License: MIT.
-
- [![NPM Stats](https://nodei.co/npm/iconv-lite.png?downloads=true)](https://npmjs.org/packages/iconv-lite/)
-
- ## Usage
- ### Basic API
- ```javascript
- var iconv = require('iconv-lite');
-
- // Convert from an encoded buffer to js string.
- str = iconv.decode(new Buffer([0x68, 0x65, 0x6c, 0x6c, 0x6f]), 'win1251');
-
- // Convert from js string to an encoded buffer.
- buf = iconv.encode("Sample input string", 'win1251');
-
- // Check if encoding is supported
- iconv.encodingExists("us-ascii")
- ```
-
- ### Streaming API (Node v0.10+)
- ```javascript
-
- // Decode stream (from binary stream to js strings)
- http.createServer(function(req, res) {
- var converterStream = iconv.decodeStream('win1251');
- req.pipe(converterStream);
-
- converterStream.on('data', function(str) {
- console.log(str); // Do something with decoded strings, chunk-by-chunk.
- });
- });
-
- // Convert encoding streaming example
- fs.createReadStream('file-in-win1251.txt')
- .pipe(iconv.decodeStream('win1251'))
- .pipe(iconv.encodeStream('ucs2'))
- .pipe(fs.createWriteStream('file-in-ucs2.txt'));
-
- // Sugar: all encode/decode streams have .collect(cb) method to accumulate data.
- http.createServer(function(req, res) {
- req.pipe(iconv.decodeStream('win1251')).collect(function(err, body) {
- assert(typeof body == 'string');
- console.log(body); // full request body string
- });
- });
- ```
-
- ### Extend Node.js own encodings
- ```javascript
- // After this call all Node basic primitives will understand iconv-lite encodings.
- iconv.extendNodeEncodings();
-
- // Examples:
- buf = new Buffer(str, 'win1251');
- buf.write(str, 'gbk');
- str = buf.toString('latin1');
- assert(Buffer.isEncoding('iso-8859-15'));
- Buffer.byteLength(str, 'us-ascii');
-
- http.createServer(function(req, res) {
- req.setEncoding('big5');
- req.collect(function(err, body) {
- console.log(body);
- });
- });
-
- fs.createReadStream("file.txt", "shift_jis");
-
- // External modules are also supported (if they use Node primitives, which they probably do).
- request = require('request');
- request({
- url: "http://github.com/",
- encoding: "cp932"
- });
-
- // To remove extensions
- iconv.undoExtendNodeEncodings();
- ```
-
- ## Supported encodings
-
- * All node.js native encodings: utf8, ucs2 / utf16-le, ascii, binary, base64, hex.
- * Additional unicode encodings: utf16, utf16-be, utf-7, utf-7-imap.
- * All widespread singlebyte encodings: Windows 125x family, ISO-8859 family,
- IBM/DOS codepages, Macintosh family, KOI8 family, all others supported by iconv library.
- Aliases like 'latin1', 'us-ascii' also supported.
- * All widespread multibyte encodings: CP932, CP936, CP949, CP950, GB2313, GBK, GB18030, Big5, Shift_JIS, EUC-JP.
-
- See [all supported encodings on wiki](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings).
-
- Most singlebyte encodings are generated automatically from [node-iconv](https://github.com/bnoordhuis/node-iconv). Thank you Ben Noordhuis and libiconv authors!
-
- Multibyte encodings are generated from [Unicode.org mappings](http://www.unicode.org/Public/MAPPINGS/) and [WHATWG Encoding Standard mappings](http://encoding.spec.whatwg.org/). Thank you, respective authors!
-
-
- ## Encoding/decoding speed
-
- Comparison with node-iconv module (1000x256kb, on MacBook Pro, Core i5/2.6 GHz, Node v0.10.26).
- Note: your results may vary, so please always check on your hardware.
-
- operation iconv@2.1.4 iconv-lite@0.4.0
- ----------------------------------------------------------
- encode('win1251') ~130 Mb/s ~380 Mb/s
- decode('win1251') ~127 Mb/s ~210 Mb/s
-
-
- ## Notes
-
- When decoding, be sure to supply a Buffer to decode() method, otherwise [bad things usually happen](https://github.com/ashtuchkin/iconv-lite/wiki/Use-Buffers-when-decoding).
- Untranslatable characters are set to � or ?. No transliteration is currently supported.
-
- ## Testing
-
- ```bash
- $ git clone git@github.com:ashtuchkin/iconv-lite.git
- $ cd iconv-lite
- $ npm install
- $ npm test
-
- $ # To view performance:
- $ node test/performance.js
- ```
-
- ## Adoption
- [![NPM](https://nodei.co/npm-dl/iconv-lite.png)](https://nodei.co/npm/iconv-lite/)
-
|