v2

.changeset/cyan-tigers-sneeze.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+feat: 문자열에서 한글을 추출해주는 extractHangul 함수를 제거합니다

.changeset/honest-roses-flow.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+feat: hasBatchim 을 utils에서 별도 함수로 분리합니다.

.changeset/kind-birds-provide.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+fix: 일관된 한글 이름 규칙 설정 함수명에서 꼭 필요하지 않다면 hangul이라는 워딩을 제거합니다

.changeset/late-beers-hang.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+feat: disassembleHangul, disassemble, disassembleHangulToGroup 함수에서 hangul이라는 글자를 제거합니다

.changeset/mighty-paws-grow.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+feat: choseongIncludes함수를 제거합니다.

.changeset/pretty-apes-destroy.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+canBeChoseong, canBeJungseong, canBeJongseong 을 utils에서 별도 함수로 분리합니다.

.changeset/smooth-rings-mix.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+hangulIncludes 함수를 제거합니다

.changeset/weak-walls-sniff.md

@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+feat: 한글의 두음을 반환해주는 acronymizeHangul 함수를 제거합니다.

.github/CONTRIBUTING.md

@@ -74,4 +74,4 @@ import hangul from 'es-hangul' // hangul default export에 묶어서도 제공
 hangul.getSimilarity(...)
 hangul.disassemble(...)
 hangul.josa(...)
-
+```

README-en_us.md

@@ -11,12 +11,16 @@ es-hangul is a library that makes it easy to handle [Hangul](https://en.wikipedi
 You can easily implement tasks related to Hangul, such as initial consonant search and attaching particles(josas).
 
 ```tsx
-import { choseongIncludes } from 'es-hangul';
+import { getChoseong } from 'es-hangul';
 
 const searchWord = '라면';
 const userInput = 'ㄹㅁ';
 
-const result = choseongIncludes(searchWord, userInput); // true
+const result = getChoseong(searchWord); // ㄹㅁ
+
+if (result === userInput) {
+  // do something
+}
 ```
 
 ```tsx

README.md

@@ -8,15 +8,19 @@
 
 ## 사용 예시
 
-초성 검색, 조사 붙이기와 같은 한글 작업을 간단히 할 수 있습니다.
+문자열 초성화, 조사 붙이기와 같은 한글 작업을 간단히 할 수 있습니다.
 
 ```tsx
-import { choseongIncludes } from 'es-hangul';
+import { getChoseong } from 'es-hangul';
 
 const searchWord = '라면';
 const userInput = 'ㄹㅁ';
 
-const result = choseongIncludes(searchWord, userInput); // true
+const result = getChoseong(searchWord); // ㄹㅁ
+
+if (result === userInput) {
+  // 일치한다면 if문이 실행
+}
 ```
 
 ```tsx

docs/src/pages/docs/api/canBe.en.md

@@ -0,0 +1,53 @@
+---
+title: canBe
+---
+
+# canBeChoseong
+
+Check if a given character can be a choseong in Korean.
+
+```typescript
+function canBeChoseong(character: string): boolean;
+```
+
+```typescript
+canBeChoseong('ㄱ'); // true
+canBeChoseong('ㅃ'); // true
+canBeChoseong('ㄱㅅ'); // false
+canBeChoseong('ㅏ'); // false
+canBeChoseong('가'); // false
+```
+
+# canBeJungseong
+
+Check if a given character can be a jungseong in Korean.
+
+```typescript
+function canBeJungseong(character: string): boolean;
+```
+
+```typescript
+canBeJungseong('ㅏ'); // true
+canBeJungseong('ㅗㅏ'); // true
+canBeJungseong('ㅏㅗ'); // false
+canBeJungseong('ㄱ'); // false
+canBeJungseong('ㄱㅅ'); // false
+canBeJungseong('가'); // false
+```
+
+# canBeJongseong
+
+Check if a given character can be a jongseong in Korean.
+
+```typescript
+function canBeJongseong(character: string): boolean;
+```
+
+```typescript
+canBeJongseong('ㄱ'); // true
+canBeJongseong('ㄱㅅ'); // true
+canBeJongseong('ㅎㄹ'); // false
+canBeJongseong('가'); // false
+canBeJongseong('ㅏ'); // false
+canBeJongseong('ㅗㅏ'); // false
+```

docs/src/pages/docs/api/canBe.ko.md

@@ -0,0 +1,53 @@
+---
+title: canBe
+---
+
+# canBeChoseong
+
+인자로 받은 문자가 초성으로 위치할 수 있는 문자인지 검사합니다.
+
+```typescript
+function canBeChoseong(character: string): boolean;
+```
+
+```typescript
+canBeChoseong('ㄱ'); // true
+canBeChoseong('ㅃ'); // true
+canBeChoseong('ㄱㅅ'); // false
+canBeChoseong('ㅏ'); // false
+canBeChoseong('가'); // false
+```
+
+# canBeJungseong
+
+인자로 받은 문자가 중성으로 위치할 수 있는 문자인지 검사합니다.
+
+```typescript
+function canBeJungseong(character: string): boolean;
+```
+
+```typescript
+canBeJungseong('ㅏ'); // true
+canBeJungseong('ㅗㅏ'); // true
+canBeJungseong('ㅏㅗ'); // false
+canBeJungseong('ㄱ'); // false
+canBeJungseong('ㄱㅅ'); // false
+canBeJungseong('가'); // false
+```
+
+# canBeJongseong
+
+인자로 받은 문자가 종성으로 위치할 수 있는 문자인지 검사합니다.
+
+```typescript
+function canBeJongseong(character: string): boolean;
+```
+
+```typescript
+canBeJongseong('ㄱ'); // true
+canBeJongseong('ㄱㅅ'); // true
+canBeJongseong('ㅎㄹ'); // false
+canBeJongseong('가'); // false
+canBeJongseong('ㅏ'); // false
+canBeJongseong('ㅗㅏ'); // false
+```