1
0
Fork 0
mirror of https://github.com/shimataro/ssh-key-action.git synced 2025-06-19 22:52:10 +10:00
ssh-key-action/node_modules/encoding
2019-09-18 20:39:54 +09:00
..
lib * first action! (#1) 2019-09-18 20:39:54 +09:00
test * first action! (#1) 2019-09-18 20:39:54 +09:00
.npmignore * first action! (#1) 2019-09-18 20:39:54 +09:00
.travis.yml * first action! (#1) 2019-09-18 20:39:54 +09:00
LICENSE * first action! (#1) 2019-09-18 20:39:54 +09:00
package.json * first action! (#1) 2019-09-18 20:39:54 +09:00
README.md * first action! (#1) 2019-09-18 20:39:54 +09:00

Encoding

encoding is a simple wrapper around node-iconv and 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 npm version

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