# jconv

> Pure JavaScript Iconv for Japanese encodings. (Shift_JIS, ISO-2022-JP, EUC-JP, UTF-8, UCS-2)

Latest version **0.1.5** (published 2014-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install jconv
pnpm add jconv
yarn add jconv
bun add jconv
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2014-02-12 |
| First published | 2013-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/jconv) |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 98 |
| Maintainers | narirou |
| Keywords | iconv, encode, encoding, charset, japanese |

## Links

- npm: https://www.npmjs.com/package/jconv
- Repository: https://github.com/narirou/jconv
- Issues: https://github.com/narirou/jconv/issues
- npm.io page: https://npm.io/package/jconv

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2014-02-12
- 0.1.4 — 2013-12-17
- 0.1.3 — 2013-12-16
- 0.1.2 — 2013-12-13
- 0.1.1 — 2013-12-11
- 0.1.0 — 2013-12-09
- 0.0.6 — 2013-12-07
- 0.0.5 — 2013-11-30
- 0.0.4 — 2013-11-30
- 0.0.3 — 2013-11-28
- 0.0.1 — 2013-11-17

## README

jconv
====================

> Pure JavaScript Iconv for Japanese encodings.

[![Build Status](https://secure.travis-ci.org/narirou/jconv.png?branch=master)](https://travis-ci.org/narirou/jconv)
[![NPM version](https://badge.fury.io/js/jconv.png)](http://badge.fury.io/js/jconv)

 * This module supported the encodings commonly used in Japanese Language:  
   *Shift_JIS(CP932), ISO-2022-JP(-1), EUC-JP, UTF8, UNICODE(UCS2)* conversion.
 * Pure Javascript, no need to compile.
 * Much faster than [node-iconv](https://github.com/bnoordhuis/node-iconv).

[[Japanese 日本語]](https://github.com/narirou/jconv/blob/master/READMEja.md)

## Installation
```bash
$ npm install jconv
```

## Usage
For example simply convert from **EUC-JP** to **Shift_JIS**:

```javascript
var jconv = require( 'jconv' );

var SJISBuffer = jconv.convert( EUCJPBuffer, 'EUCJP', 'SJIS' );
```

Also available **iconv-lite** syntax:

```javascript
var str = jconv.decode( buffer, fromEncoding );

var buf = jconv.encode( 'string', toEncoding );
```

## API
 * **jconv( input, fromEncoding, toEncoding )**  
 * **jconv.convert( input, fromEncoding, toEncoding )**  
    * `input` {Buffer} or {String}  
    * `fromEncoding`, `toEncoding` {String}:  
       *Shift_JIS(SJIS), ISO-2022-JP(JIS), EUCJP, UTF8, UNICODE(UCS2, UTF16LE)* are available.  
    * `return` {Buffer}  

 * **jconv.decode( inputBuffer, fromEncoding )**  
    * `return` {String}  

 * **jconv.encode( inputString, toEncoding )**  
    * `return` {Buffer}  

 * **jconv.encodingExists( encodingName )**  
    * `return` {Boolean}

## Performance
Comparison with node-iconv@2.0.7 by converting [Japanese text](http://www.aozora.gr.jp/cards/000148/files/773_14560.html)
using [Benchmark.js](https://github.com/bestiejs/benchmark.js).  
Environment is *Windows7, core i5 2405-S, mem8G, Node 0.10.22*.
(Please check on your hardware.)  
`Gray`: iconv, `Blue`: jconv (higher is better)  

![jconv - encoding speed test chart](https://raw.github.com/narirou/jconv/master/test/chart/speedLog.png)
[[latest log]](https://github.com/narirou/jconv/blob/master/test/chart/speedLog.txt)  

## Encodings
 * Supported: Shift_JIS(CP932), ISO-2022-JP(-1), EUC-JP, UTF8, UNICODE(UCS2).  
 
 * Supported Windows Dependent Characters <-> JIS Conversion.  
[(problem details)](http://support.microsoft.com/default.aspx?scid=kb;ja;JP170559)  

 * "JIS X 0208", "JIS X 0212" and "CP932" have the Unicode Mapping Table Differences,
  so the specific characters ( ～￠￡∥ etc... ) cannot be round-trip converted by default.  
 This module corrects this difference as much as possible when converting.  
[(problem details)](http://www8.plala.or.jp/tkubota1/unicode-symbols-map2.html)  

## Development 
 * Clone Repository  
```
git clone https://github.com/narirou/jconv.git  
cd jconv  
npm install
```

 * Generate Tables  
```
# generates the unicode mapping table module in "tables" folder.
node generators/generate-source  
node generators/generate
```

 * Test
```
grunt test
```

 * Speed Test  
```
# First, minify the script by closure-compiler.
grunt minify
```
``` 
node test/speed  
# This results are visualized by chart.js.  
# Plese open "chart/index.html".
```

## Based on
 * [iconv-lite](https://github.com/ashtuchkin/iconv-lite) by ashtuchkin.
 * [Encoding.js](https://github.com/polygonplanet/Unzipper.js) by polygonplanet.
 * [iconv-js](https://github.com/Hikaru02/iconv-js) by Hikaru02.
 * [node-iconv](https://github.com/bnoordhuis/node-iconv) by bnoordhuis.
 * [libiconv-1.9.1-ja-patch Description](http://www2d.biglobe.ne.jp/~msyk/software/libiconv-1.9.1-patch.html) by 森山 将之.

Thank you so much!

## Note
Pull requests are welcome.

## Todo
 * Streaming API support
 * Support more encodings and languages.

---
_Source: https://npm.io/package/jconv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._