diff options
author | Rebecca Turner <me@re-becca.org> | 2018-04-20 18:26:37 -0700 |
---|---|---|
committer | Michaël Zasso <targos@protonmail.com> | 2018-05-25 14:03:01 +0200 |
commit | d0cdcb61fe3a237be7d905cecc9ff1b95dbfdfa3 (patch) | |
tree | 9100e1f9c144368752be8c448d65bcd2bc8001a5 /deps/npm/node_modules/encoding/README.md | |
parent | 1f3eb1cc1ec74b514f6e54fa88537818472bcb4d (diff) | |
download | node-new-d0cdcb61fe3a237be7d905cecc9ff1b95dbfdfa3.tar.gz |
deps: upgrade npm to 6.1.0
PR-URL: https://github.com/nodejs/node/pull/20190
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Diffstat (limited to 'deps/npm/node_modules/encoding/README.md')
-rw-r--r-- | deps/npm/node_modules/encoding/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/deps/npm/node_modules/encoding/README.md b/deps/npm/node_modules/encoding/README.md new file mode 100644 index 0000000000..62e6bf88f7 --- /dev/null +++ b/deps/npm/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. + +[](http://travis-ci.org/andris9/Nodemailer) +[](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** |