docs: susa 함수에 jsdoc을 추가합니다. (#250)

* docs: susa 함수에 jsdoc을 추가합니다. * Update src/susa/susa.ts Co-authored-by: Bosung Baek <[email protected]> * Update src/susa/susa.ts Co-authored-by: Bosung Baek <[email protected]> * Create two-ravens-end.md --------- Co-authored-by: Bosung Baek <[email protected]>
toss · Sep 15, 2024 · c0ca9f5 · c0ca9f5
1 parent f3e9024
commit c0ca9f5
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/.changeset/two-ravens-end.md b/.changeset/two-ravens-end.md
@@ -0,0 +1,5 @@
+---
+"es-hangul": patch
+---
+
+docs: susa 함수에 jsdoc을 추가합니다.
diff --git a/src/susa/susa.ts b/src/susa/susa.ts
@@ -1,6 +1,32 @@
 import { hasProperty } from '../_internal';
 import { SUSA_MAP, SUSA_CLASSIFIER_MAP } from './constants';
 
+/**
+ * 숫자를 순 우리말 수사로 변환합니다. 주어진 숫자가 0보다 크고 100 이하일 때 유효합니다.
+ *
+ * @remarks
+ * - **수사**란 숫자를 나타내는 우리말 단어입니다. [자세히 알아보기](https://ko.dict.naver.com/#/entry/koko/d0ce2b674cae4b44b9028f648dd458b0)
+ * - **수관형사**는 사물의 수나 양을 나타내는 관형사입니다. ‘두 사람’의 ‘두’, ‘세 근’의 ‘세’ 따위를 뜻 합니다. [자세히 알아보기](https://ko.dict.naver.com/#/entry/koko/c513782b82554ff499c80ec616c5b611)
+ *
+ * @param num 숫자를 입력합니다.
+ * @param classifier 수관형사를 사용할지 여부를 입력합니다. 기본값은 false입니다.
+ * @returns 변환된 수사를 반환합니다.
+ *
+ * @example
+ * susa(1); // '하나'
+ * susa(2); // '둘'
+ * susa(11); // '열하나'
+ * susa(21); // '스물하나'
+ * susa(99); // '아흔아홉'
+ * susa(100); // '백'
+ * susa(1, true); // '한'
+ * susa(2, true); // '두'
+ * susa(11, true); // '열한'
+ * susa(20, true); // '스무'
+ * susa(21, true); // '스물한'
+ *
+ * @see https://es-hangul.slash.page/docs/api/susa
+ */
 export function susa(num: number, classifier?: boolean): string {
   validateNumber(num);
   return classifier ? getClassifierWord(num) : getNumberWord(num);