From 2e95b0f7f260d2d66ae7a3dafd3c6f890477914f Mon Sep 17 00:00:00 2001
From: minsoo-web <zlemzlem5656@naver.com>
Date: Sun, 15 Sep 2024 20:46:43 +0900
Subject: [PATCH] =?UTF-8?q?docs:=20susa=20=ED=95=A8=EC=88=98=EC=97=90=20js?=
 =?UTF-8?q?doc=EC=9D=84=20=EC=B6=94=EA=B0=80=ED=95=A9=EB=8B=88=EB=8B=A4.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/susa/susa.ts | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/susa/susa.ts b/src/susa/susa.ts
index e0f30d02..f684c24b 100644
--- a/src/susa/susa.ts
+++ b/src/susa/susa.ts
@@ -1,6 +1,27 @@
 import { hasProperty } from '../_internal';
 import { SUSA_MAP, SUSA_CLASSIFIER_MAP } from './constants';
 
+/**
+ * 숫자를 순 우리말 수사로 변환합니다. 주어진 숫자가 0보다 크고 100 이하일 때 유효합니다.
+ * @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);