https://github.com/fujaru/aromanize-js
Korean transliteration tool for JavaScript
https://github.com/fujaru/aromanize-js
hangul hiragana javascript katakana romaja romaji romanization string transcription transliteration unicode
Last synced: 6 months ago
JSON representation
Korean transliteration tool for JavaScript
- Host: GitHub
- URL: https://github.com/fujaru/aromanize-js
- Owner: fujaru
- License: mit
- Created: 2017-12-06T05:09:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-19T08:23:22.000Z (about 8 years ago)
- Last Synced: 2025-10-19T00:00:49.511Z (9 months ago)
- Topics: hangul, hiragana, javascript, katakana, romaja, romaji, romanization, string, transcription, transliteration, unicode
- Language: JavaScript
- Homepage:
- Size: 23.4 KB
- Stars: 19
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.draft.md
- License: LICENSE
Awesome Lists containing this project
README
# Aromanize-js
*Notice: This project is currently under development.*
Japanese & Korean transliteration tool for JavaScript
Aromanize extends the functionality of JavaScript's String class for transliterating between Hangul (한글), Hiragana (ひらがな), Katakana (カタカナ), to Latin (ローマ字/로마자) script.
## Usage
### HTML
Include `aromanize.js` into your HTML page. All is set!
```
// Converts to Latin script
"안녕하세요?".romanize(); // annyeonghaseyo?
// Converts to Hangul
"annyeonghaseyo?".toHangul(); // 안녕하세요?
// Converts to Hiragana
"ラーメン".toHiragana(); // らあめん
// Converts to Katakana
"らあめん".toKatakana(); // ラーメン
// Alternative way to romanize
Aromanize.romanize("안녕하세요?"); // annyeonghaseyo?
```
### Node.js
This module can be installed via npm:
```
$ npm install aromanize --save
```
```
require("aromanize");
// Converts to Latin script
"안녕하세요?".romanize(); // annyeonghaseyo?
// Converts to Hangul
"annyeonghaseyo?".toHangul(); // 안녕하세요?
// Converts to Hiragana
"ラーメン".toHiragana(); // らあめん
// Converts to Katakana
"らあめん".toKatakana(); // ラーメン
// Alternative way to romanize
Aromanize.romanize("안녕하세요?"); // annyeonghaseyo?
```
### Command Line
CLI is available when installed via npm:
```
$ npm install aromanize -g
$ aromanize --romanize "안녕하세요?"
Usage:
aromanize [script] [options]
Example:
aromanize -r "안녕하세요?"
Script:
-r, --romanize Converts to Latin script
-h, --hangul Converts to Hangul
-i, --hiragana Converts to Hiragana
-k, --katakana Converts to Katakana
When script is not provided, it will default to romanize
Options:
--rule=RULE Transliteration/transcription rule
-p, --ignore-phonology Ignore phonological changes
```
## License
Aromanize-js is released under the MIT License.
© 2017 Fajar Chandra