diff options
author | Florian Dold <florian.dold@gmail.com> | 2016-10-10 03:43:44 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2016-10-10 03:43:44 +0200 |
commit | abd94a7f5a50f43c797a11b53549ae48fff667c3 (patch) | |
tree | ab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/encoding/README.md | |
parent | a0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff) | |
download | wallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz |
add node_modules to address #4364
Diffstat (limited to 'node_modules/encoding/README.md')
-rw-r--r-- | node_modules/encoding/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/node_modules/encoding/README.md b/node_modules/encoding/README.md new file mode 100644 index 000000000..62e6bf88f --- /dev/null +++ b/node_modules/encoding/README.md @@ -0,0 +1,52 @@ +# Encoding + +**encoding** is a simple wrapper around [node-iconv](https://github.com/bnoordhuis/node-iconv) and [iconv-lite](https://github.com/ashtuchkin/iconv-lite/) to convert strings from one encoding to another. If node-iconv is not available for some reason, +iconv-lite will be used instead of it as a fallback. + +[![Build Status](https://secure.travis-ci.org/andris9/encoding.svg)](http://travis-ci.org/andris9/Nodemailer) +[![npm version](https://badge.fury.io/js/encoding.svg)](http://badge.fury.io/js/encoding) + +## Install + +Install through npm + + npm install encoding + +## Usage + +Require the module + + var encoding = require("encoding"); + +Convert with encoding.convert() + + var resultBuffer = encoding.convert(text, toCharset, fromCharset); + +Where + + * **text** is either a Buffer or a String to be converted + * **toCharset** is the characterset to convert the string + * **fromCharset** (*optional*, defaults to UTF-8) is the source charset + +Output of the conversion is always a Buffer object. + +Example + + var result = encoding.convert("ÕÄÖÜ", "Latin_1"); + console.log(result); //<Buffer d5 c4 d6 dc> + +## iconv support + +By default only iconv-lite is bundled. If you need node-iconv support, you need to add it +as an additional dependency for your project: + + ..., + "dependencies":{ + "encoding": "*", + "iconv": "*" + }, + ... + +## License + +**MIT** |