README-en_us.md

es-hangul

한국어 | English

es-hangul is a library that makes it easy to handle Hangul in JavaScript. It provides a modern API that is easy to use. Because it uses ECMAScript Modules, users can download the minimum amount of code when used in a browser environment.

Examples

You can easily implement tasks related to Hangul, such as initial consonant search and attaching particles(josas).

import { getChoseong } from 'es-hangul';

const searchWord = '라면';
const userInput = 'ㄹㅁ';

const result = getChoseong(searchWord); // ㄹㅁ

// Check if the 'choseong' of the search word match the user input
if (result === userInput) {
  something()
}

import { josa } from 'es-hangul';

const word1 = '사과';
const sentence1 = josa(word1, '을/를') + ' 먹었습니다.';
console.log(sentence1); // '사과를 먹었습니다.'

const word2 = '바나나';
const sentence2 = josa(word2, '이/가') + ' 맛있습니다.';
console.log(sentence2); // '바나나가 맛있습니다.'

Contributing

We welcome contribution from everyone in the community. Read below for detailed contribution guide.

CONTRIBUTING

Thanks to

We would like to express our special thanks to the owners of the following libraries for their significant contributions to the JavaScript ecosystem related to Hangul and for inspiring many developers: hangul-js: Jae-min Jo

License

MIT © Viva Republica, Inc. See LICENSE for details.