es-hangul

es-hangul is a high-performance library designed for handling Hangul (Korean alphabet) in JavaScript applications. It provides interfaces for common business requirements such as initial consonant (Choseong) search, automatic particle (Josa) attachment, and decomposing/assembling Hangul characters into their constituent parts (Choseong, Jungseong, Jongseong).

Key features include:

• Tree-shakable: Built with ECMAScript Modules, allowing you to include only the functions you use.
• TypeScript Support: Provides strong typing for better developer experience.
• High Performance: Optimized for complex Hangul assembly and disassembly tasks.

Standardizing pronunciation relies on linguistic rules (like the 'Addition of Sounds' rule in Korean Orthography). However, determining if a word is a compound or derivative word is difficult using only code without external linguistic data.

Because of this, es-hangul manages certain linguistic exceptions (where a rule might suggest one pronunciation, but the actual standard is different) using a separate constant list.

Example of an exception:

• According to the 'Addition of Sounds' rule, 전역 (jeon-yeok) might be expected to be pronounced as 전녁 (jeon-nyeok).
• However, since 전역 is not a compound or derivative, it is exceptionally pronounced as 저녁 (jeo-nyeok).

If you encounter words that require exception handling, the project encourages community contributions.

Unlike many existing Hangul processing libraries, es-hangul is written in TypeScript. This provides several advantages for developers:

• Type Safety: Enhances code safety and maintainability by preventing errors during development.
• Improved Readability: Function input and output types are clearly defined.
• Developer Efficiency: Full support for IDE auto-completion features, making it easier to discover and use available functions.

Unlike many legacy Hangul processing libraries, es-hangul is written entirely in TypeScript. This provides several advantages for developers:

• Type Safety: Prevents common errors during development by ensuring inputs and outputs match expected types.
• Improved Maintainability: Clearer code structure through explicitly defined function signatures.
• Enhanced Developer Experience: Full IDE autocomplete support for all functions and parameters, making it easier to discover and use the API without constant documentation lookups.
• Predictable Outputs: Explicitly defined return types ensure you know exactly what kind of Hangul transformation result to expect.

The curriedCombineHangulCharacter function was removed as it was not intended for direct user use. If you require this pattern, you can implement it manually using combineCharacter:

export const curriedCombineHangulCharacter=
  (firstCharacter: string) =>
  (middleCharacter: string) =>
  (lastCharacter = '') =>
    combineCharacter(firstCharacter, middleCharacter, lastCharacter);

To use es-hangul in your project, install it using npm:

npm install es-hangul

The choseongIncludes and chosungIncludes functions have been removed. To check if a string contains specific initial consonants (choseong), use getChoseong to extract them and then use the standard JavaScript .includes() method.

// ASIS
chosungIncludes('바나나', 'ㅂㄴㄴ');
choseongIncludes('바나나', 'ㅂㄴㄴ');

// TOBE
const choseonged = getChoseong('바나나');
choseonged.includes('ㅂㄴㄴ');

The functions choseongIncludes and chosungIncludes have been removed. To check if a string contains specific initial consonants (choseong), use getChoseong to transform the string first, then use the standard JavaScript .includes() method.

// Replacement pattern
const choseonged = getChoseong('바나나');
choseonged.includes('ㅂㄴㄴ');