jamo

Documentation

Index

• func ComposeHangeul(syllables string) (composedHangeuls []string, err error)
• func DecomposeHangeul(hangeuls string, opts ...options.Options) (decomposedHangeul string)
• type SyllableType
  • func ClassifySyllables(syllable rune) SyllableType

Functions

func ComposeHangeul

func ComposeHangeul(syllables string) (composedHangeuls []string, err error)

Compose Syllables into hangeul word(not words)

// example
fmt.Println(ComposeHangeul("ㅎㅏㄴㄱㅡㄹ")) // "한글"

* TODO: Flexible to better suit user intent

func DecomposeHangeul

func DecomposeHangeul(hangeuls string, opts ...options.Options) (decomposedHangeul string)

Decompose Hangeul words into Syllables

// example
fmt.Println(DecomposeHangeul("한글 is hangeul!")) // "ㅎㅏㄴㄱㅡㄹ is hangeul!"

* TODO: Allow to apply serveral option (now only first option can apply)

Types

type SyllableType

type SyllableType int

classify hangeul's syllable into consonant, vowel and undefined

const (
	Undefined SyllableType = iota
	Consonant
	Vowel
)

func ClassifySyllables

func ClassifySyllables(syllable rune) SyllableType

Classify Syllables into hangeul's consonant, vowel and undefined

// example
fmt.Println(ClassifySyllables("ㅎ")) // jamo.Consonant

* TODO: Flexible to better suit user intent