test: disassembleCompleteHangulCharacter 테스트 추가 (#126)

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

* chore: 함수 관련 설명 주석 추가

src/disassembleCompleteHangulCharacter.spec.ts

@@ -32,4 +32,9 @@ describe('disassembleCompleteHangulCharacter', () => {
  last: 'ㄱ',
  });
  });
+
+ it('완전한 한글 문자열이 아니면 undefined를 반환해야 합니다.', () => {
+ expect(disassembleCompleteHangulCharacter('ㄱ')).toBeUndefined;
+ expect(disassembleCompleteHangulCharacter('ㅏ')).toBeUndefined;
+ });
 });

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 {