Class HangulService

class HangulService

transform hangul to qwerty type.

Hierarchy

HangulService

Index

Constructors

Properties

CHOSEONG JONGSEONG JUNGSEONG JamoDecomposeMap QwertyMap

Methods

asAlphabetKeyStokes asBasicJamoSequence asChoseongSequence asJamoSequence hello isHangul isHangulChar isHangulCompatibilityJamo isHangulJamo isHangulSyllable

Constructors

constructor

new HangulService(): HangulService
Returns HangulService

Properties

`Static` `Readonly` CHOSEONG

CHOSEONG: string[] = ...

1.Initial consonants (초성)

`Static` `Readonly` JONGSEONG

JONGSEONG: string[] = ...

Final consonants (종성)

`Static` `Readonly` JUNGSEONG

JUNGSEONG: string[] = ...

Medial vowels (중성)

`Static` `Protected` `Readonly` JamoDecomposeMap

JamoDecomposeMap: Map<string, string> = ...

Hangul Composite Jamo(겹자모) -> Hangul Basic Jamo(기본 자모)

`Static` `Protected` `Readonly` QwertyMap

QwertyMap: Map<string, string> = ...

Hangul Jamo -> Alphabet (in QWERTY 2벌식)

Methods

asAlphabetKeyStokes

asAlphabetKeyStokes(text: string): string
Transform to Alphabet key stroke sequence (for QWERTY/Korean 2-bul) e.g. '한글' -> 'gksrmf'
Parameters
- text: string
  
  input text
Returns string
- Defined in src/cores/elastic/hangul-service.ts:145

asBasicJamoSequence

asBasicJamoSequence(text: string): string
Decompose the text to Hangul Basic Jamo sequence (for Search-As-You-Type)
- 다양한 종류의 입력 방식(e.g. 세벌식) 지원을 위해 최소 단위인 기본 자모(24자)로 분해함 e.g. '한글' -> 'ㅎㅏㄴㄱㅡㄹ', '맴찟' -> 'ㅁㅏㅣㅁㅈㅈㅣㅅ'
Parameters
- text: string
  
  input text
Returns string
- Defined in src/cores/elastic/hangul-service.ts:132

asChoseongSequence

asChoseongSequence(text: string): string
초성만을 추출 (Korean only) e.g. 한글 -> ㅎㄱ
Parameters
- text: string
  
  input text
Returns string
- Defined in src/cores/elastic/hangul-service.ts:158

asJamoSequence

asJamoSequence(text: string): string
Decompose text into Hangul (Compatibility) Jamo sequence
- 초성, 중성, 종성으로 분해 e.g. '한글' -> 'ㅎㅏㄴㄱㅡㄹ', '맴찟' -> 'ㅁㅐㅁㅉㅣㅅ'
[Note] 유니코드 한글 자모는 초/중/종성에 서로 다른 코드 영역이 할당되어 있다. 따라서 동일한 자모라도 초성에 위치할 때와 종성에 위치할 때 코드값이 다르다. (예. 초성 'ㄱ': U+1100, 종성 'ㄱ': U+11A8) 이를 Compatibility Jamo로서 같은 코드값을 사용하도록 변형한다. [Reference]
- https://en.wikipedia.org/wiki/Hangul_Jamo_(Unicode_block)
- https://en.wikipedia.org/wiki/Hangul_Compatibility_Jamo
Parameters
- text: string
  
  input text
Returns string
- Defined in src/cores/elastic/hangul-service.ts:102

hello

hello(): string
say hello

Returns string
- Defined in src/cores/elastic/hangul-service.ts:70

isHangul

isHangul(text: string, partial?: boolean): boolean
Identify whether given text is Hangul or not
Parameters
- text: string
  
  input text
- partial: boolean = false
  
  (optional) if set true, result is true if there is at least one Korean letter in the text (default: false)
Returns boolean
- Defined in src/cores/elastic/hangul-service.ts:78

`Static` isHangulChar

isHangulChar(code: number): boolean
Check the code is Hangul Unicode character
Parameters
- code: number
  
  character code
Returns boolean
- Defined in src/cores/elastic/hangul-service.ts:175

`Static` isHangulCompatibilityJamo

isHangulCompatibilityJamo(code: number): boolean
Check the code is Hangul Compatibility Jamo
Parameters
- code: number
  
  character code
Returns boolean
- Defined in src/cores/elastic/hangul-service.ts:207

`Static` isHangulJamo

isHangulJamo(code: number): boolean
Check the code is Hangul Jamo
Parameters
- code: number
  
  character code
Returns boolean
- Defined in src/cores/elastic/hangul-service.ts:198

`Static` isHangulSyllable

isHangulSyllable(code: number): boolean
Check the code is Hangul syllable
Parameters
- code: number
  
  character code
Returns boolean
- Defined in src/cores/elastic/hangul-service.ts:189

Generated using TypeDoc