feat: getFirstConsonants에 deprecated를추가

toss · Apr 25, 2024 · 546d51e · 546d51e
1 parent de72eee
commit 546d51e
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/src/utils.ts b/src/utils.ts
@@ -72,6 +72,28 @@ export function getChosung(word: string) {
   }, '');
 }
 
+/**
+ * @name getFirstConsonants
+ * @deprecated getChosung을 사용해 주세요.
+ * @description
+ * 단어에서 초성을 추출합니다. (예: `사과` -> `'ㅅㄱ'`)
+ * ```typescript
+ * getFirstConsonants(
+ *   // 초성을 추출할 단어
+ *   word: string
+ * ): string
+ * ```
+ * @example
+ * getFirstConsonants('사과') // 'ㅅㄱ'
+ * getFirstConsonants('리액트') // 'ㄹㅇㅌ'
+ * getFirstConsonants('띄어 쓰기') // 'ㄸㅇ ㅆㄱ'
+ */
+export function getFirstConsonants(word: string) {
+  return disassembleHangulToGroups(word).reduce((firstConsonants, [consonant]) => {
+    return `${firstConsonants}${consonant}`;
+  }, '');
+}
+
 /**
  * @name canBeChosung
  * @description