feat: jsDoc으로 설명 추가

BCSDLab · Jun 12, 2024 · 8e77f85 · 8e77f85
1 parent e60d0e2
commit 8e77f85
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/utils/hooks/useFunnel.ts b/src/utils/hooks/useFunnel.ts
@@ -9,6 +9,11 @@ export interface FunnelProps {
   children: ReactElement<StepProps>[];
 }
 
+/**
+* 단계별 입력 폼을 진행할 시 사용 권장
+* @param { string } defaultStep 시작할 초기 단계
+* @returns { Funnel, Step, setStep, currentStep } 단계별 입력 폼을 관리하는데 사용하는 유틸리티
+*/
 export const useFunnel = (defaultStep: string) => {
   const [step, setStep] = useState(defaultStep);