Skip to content

Commit

Permalink
docs: JSDOC 내용 보완
Browse files Browse the repository at this point in the history
  • Loading branch information
itscold96 committed Jun 14, 2024
1 parent 91272cf commit 08d75db
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
14 changes: 7 additions & 7 deletions javascript/auth/form.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ const validateSubmit = () => {
/**
* 입력값이 유효하지 않은 경우, error 스타일을 적용시키는 함수
*
* @param {*} input input element
* @param {*} message 에러 발생 시 input element 아래에 표출될 메시지
* @param {HTMLInputElement} input input element
* @param {string} message 에러 발생 시 input element 아래에 표출될 메시지
*/
const showError = (input, message) => {
// 비밀번호 표시 숨김 아이콘을 position: absolute로 설정하여 위치를 잡아주기 위해
Expand All @@ -72,7 +72,7 @@ const showError = (input, message) => {
/**
* 입력값이 유효한 값인 경우, success 스타일을 적용시키는 함수
*
* @param {*} input element
* @param {HTMLInputElement} input input element
*/
const showSuccess = (input) => {
const inputWrapper =
Expand All @@ -86,7 +86,7 @@ const showSuccess = (input) => {
/**
* 입력된 이메일란 내용을 유효성 검사하여 error 혹은 success를 판별하는 함수
*
* @param {*} event event object
* @param {Event} event event object
* @returns error 혹은 success 결과에 따른 스타일 적용 함수
*/
const validateEmail = (event) => {
Expand All @@ -108,7 +108,7 @@ const validateEmail = (event) => {
/**
* 입력된 닉네임란 내용을 유효성 검사하여 error 혹은 success를 판별하는 함수
*
* @param {*} event event object
* @param {Event} event event object
* @returns error 혹은 success 결과에 따른 스타일 적용 함수
*/
const validateNickname = (event) => {
Expand Down Expand Up @@ -142,7 +142,7 @@ const validatePasswordMatch = () => {
/**
* 입력된 비밀번호란 내용을 유효성 검사하여 error 혹은 success를 판별하는 함수
*
* @param {*} event event object
* @param {Event} event event object
* @returns error 혹은 success 결과에 따른 스타일 적용 함수
*/
const validatePassword = (event) => {
Expand All @@ -168,7 +168,7 @@ const validatePassword = (event) => {
/**
* 현재 위치에 따라 서로 다른 routing을 실행하는 form submit 함수
*
* @param {*} event event object
* @param {Event} event event object
*/
const handleSubmit = (event) => {
event.preventDefault();
Expand Down
2 changes: 1 addition & 1 deletion javascript/auth/password.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const passwordVisiblityIcons = document.querySelectorAll(
/**
* 눈 모양 아이콘을 클릭 시, 비밀번호 숨김/보기 처리를 하는 함수
*
* @param {*} event event object
* @param {Event} event event object
*/
const handleEyeClick = (event) => {
const eye = event.currentTarget;
Expand Down
5 changes: 5 additions & 0 deletions javascript/utils/location.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* 인자로 들어온 경로로 페이지를 이동하는 함수
*
* @param {string} href
*/
export const moveLocation = (href) => {
location.href = href;
};

0 comments on commit 08d75db

Please sign in to comment.