From c9afca07c963e78c5cb78710bec99dd8d1e1cf67 Mon Sep 17 00:00:00 2001
From: jgjgill <79239852+jgjgill@users.noreply.github.com>
Date: Wed, 19 Jun 2024 22:06:38 +0900
Subject: [PATCH] =?UTF-8?q?test:=20disassembleCompleteHangulCharacter=20?=
 =?UTF-8?q?=ED=85=8C=EC=8A=A4=ED=8A=B8=20=EC=B6=94=EA=B0=80=20(#126)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* test: 완전한 한글 문자열이 아닌 경우 undefined 확인하는 테스트 추가

* chore: 함수 관련 설명 주석 추가
---
 src/disassembleCompleteHangulCharacter.spec.ts |  5 +++++
 src/disassembleCompleteHangulCharacter.ts      | 14 ++++++++++++++
 2 files changed, 19 insertions(+)

diff --git a/src/disassembleCompleteHangulCharacter.spec.ts b/src/disassembleCompleteHangulCharacter.spec.ts
index 6dea94b6..97880110 100644
--- a/src/disassembleCompleteHangulCharacter.spec.ts
+++ b/src/disassembleCompleteHangulCharacter.spec.ts
@@ -32,4 +32,9 @@ describe('disassembleCompleteHangulCharacter', () => {
       last: 'ㄱ',
     });
   });
+
+  it('완전한 한글 문자열이 아니면 undefined를 반환해야 합니다.', () => {
+    expect(disassembleCompleteHangulCharacter('ㄱ')).toBeUndefined;
+    expect(disassembleCompleteHangulCharacter('ㅏ')).toBeUndefined;
+  });
 });
diff --git a/src/disassembleCompleteHangulCharacter.ts b/src/disassembleCompleteHangulCharacter.ts
index 3cb5c7a5..0e255c83 100644
--- a/src/disassembleCompleteHangulCharacter.ts
+++ b/src/disassembleCompleteHangulCharacter.ts
@@ -14,6 +14,20 @@ interface ReturnTypeDisassembleCompleteHangulCharacter {
   last: (typeof HANGUL_CHARACTERS_BY_LAST_INDEX)[number];
 }
 
+/**
+ * @name disassembleCompleteHangulCharacter
+ * @description
+ * 완전한 한글 문자열을 초성, 중성, 종성으로 분리합니다.
+ *
+ * @param {string} letter 분리하고자 하는 완전한 한글 문자열
+ *
+ * @example
+ * disassembleCompleteHangulCharacter('값') // { first: 'ㄱ', middle: 'ㅏ', last: 'ㅂㅅ' }
+ * disassembleCompleteHangulCharacter('리') // { first: 'ㄹ', middle: 'ㅣ', last: '' }
+ * disassembleCompleteHangulCharacter('빚') // { first: 'ㅂ', middle: 'ㅣ', last: 'ㅈ' }
+ * disassembleCompleteHangulCharacter('박') // { first: 'ㅂ', middle: 'ㅏ', last: 'ㄱ' }
+ */
+
 export function disassembleCompleteHangulCharacter(
   letter: string
 ): ReturnTypeDisassembleCompleteHangulCharacter | undefined {