source: trip-planner-front/node_modules/encoding/README.md@ 6a3a178

Last change on this file since 6a3a178 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 1.3 KB
Line 
1# Encoding
2
3**encoding** is a simple wrapper around [iconv-lite](https://github.com/ashtuchkin/iconv-lite/) to convert strings from one encoding to another.
4
5[![Build Status](https://secure.travis-ci.org/andris9/encoding.svg)](http://travis-ci.org/andris9/Nodemailer)
6[![npm version](https://badge.fury.io/js/encoding.svg)](http://badge.fury.io/js/encoding)
7
8Initially _encoding_ was a wrapper around _node-iconv_ (main) and _iconv-lite_ (fallback) and was used as the encoding layer for Nodemailer/mailparser. Somehow it also ended up as a dependency for a bunch of other project, none of these actually using _node-iconv_. The loading mechanics caused issues for front-end projects and Nodemailer/malparser had moved on, so _node-iconv_ was removed.
9
10## Install
11
12Install through npm
13
14 npm install encoding
15
16## Usage
17
18Require the module
19
20 var encoding = require("encoding");
21
22Convert with encoding.convert()
23
24 var resultBuffer = encoding.convert(text, toCharset, fromCharset);
25
26Where
27
28- **text** is either a Buffer or a String to be converted
29- **toCharset** is the characterset to convert the string
30- **fromCharset** (_optional_, defaults to UTF-8) is the source charset
31
32Output of the conversion is always a Buffer object.
33
34Example
35
36 var result = encoding.convert("ÕÄÖÜ", "Latin_1");
37 console.log(result); //<Buffer d5 c4 d6 dc>
38
39## License
40
41**MIT**
Note: See TracBrowser for help on using the repository browser.