Uni typer

Uni typer is a tool for splitting unicode characters into their individual components.

It is useful for debugging and understanding how unicode characters are composed.

Current status

2024.06.04: Decomposition and Composition of Hangul characters are supported.

Installation

npm add @beavercoding/uni-typer

yarn add @beavercoding/uni-typer

pnpm add @beavercoding/uni-typer

Module System

CJS and ESM are supported.

Usage

1import { decompose } from '@beavercoding/uni-typer';
2// const { decompose } = require('@beavercoding/uni-typer');
3
4const simple = decompose('가나다', 'simple');
5
6// ["ㄱ","ㅏ","ㄴ","ㅏ","ㄷ","ㅏ"]
7
8const detailed = decompose('가나다');
9
10// [
11//   {
12//     wordBeforeCharIndex: '',
13//     char: '가',
14//     charIndex: 0,
15//     decomposedSingle: [ 'ㄱ', 'ㅏ' ],
16//     currentWord: '가나다',
17//     flatIndex: 0,
18//     decomposedAtIndex: 'ㄱ',
19//     decomposedIndex: 0
20//   },
21//   {
22//     wordBeforeCharIndex: '',
23//     char: '가',
24//     charIndex: 0,
25//     decomposedSingle: [ 'ㄱ', 'ㅏ' ],
26//     currentWord: '가나다',
27//     flatIndex: 1,
28//     decomposedAtIndex: 'ㅏ',
29//     decomposedIndex: 1
30//   },
31//   {
32//     wordBeforeCharIndex: '가',
33//     char: '나',
34//     charIndex: 1,
35//     decomposedSingle: [ 'ㄴ', 'ㅏ' ],
36//     currentWord: '가나다',
37//     flatIndex: 2,
38//     decomposedAtIndex: 'ㄴ',
39//     decomposedIndex: 0
40//   },
41//   {
42//     wordBeforeCharIndex: '가',
43//     char: '나',
44//     charIndex: 1,
45//     decomposedSingle: [ 'ㄴ', 'ㅏ' ],
46//     currentWord: '가나다',
47//     flatIndex: 3,
48//     decomposedAtIndex: 'ㅏ',
49//     decomposedIndex: 1
50//   },
51//   {
52//     wordBeforeCharIndex: '가나',
53//     char: '다',
54//     charIndex: 2,
55//     decomposedSingle: [ 'ㄷ', 'ㅏ' ],
56//     currentWord: '가나다',
57//     flatIndex: 4,
58//     decomposedAtIndex: 'ㄷ',
59//     decomposedIndex: 0
60//   },
61//   {
62//     wordBeforeCharIndex: '가나',
63//     char: '다',
64//     charIndex: 2,
65//     decomposedSingle: [ 'ㄷ', 'ㅏ' ],
66//     currentWord: '가나다',
67//     flatIndex: 5,
68//     decomposedAtIndex: 'ㅏ',
69//     decomposedIndex: 1
70//   }
71// ]

1import { combine } from '@beavercoding/uni-typer';
2
3combine([
4    "ㄱ",
5    "ㅏ",
6    "ㄴ",
7    "ㅏ",
8    "ㄷ",
9    "ㅏ",
10  ])
11// 가나다
12
13combine([
14  "ㅂ", "ㅜ", "ㅔ", "ㄹ", "ㄱ", "ㅅ", "ㅡ"
15])
16// 뷁스

Contribution

Please feel free to contribute to this project.

Contact

on this repository, Email: pcj9024@gmail.com , Discord: https://discord.gg/jj2cfVsX , KakaoTalk: https://open.kakao.com/me/beavercoding2022 ,