docs: jsdoc account service

hywax · Aug 5, 2024 · 0611074 · 0611074
1 parent e2b4644
commit 0611074
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/apps/web/server/services/account.ts b/apps/web/server/services/account.ts
@@ -21,6 +21,12 @@ interface AccountDeleteData {
   password: string
 }
 
+/**
+ * Change self account password
+ *
+ * @param data
+ * @returns void
+ */
 export async function accountChangePassword(data: AccountChangePasswordData): Promise<void> {
   const db = useDatabase()
   const changePasswordSchema = z.object({
@@ -49,6 +55,12 @@ export async function accountChangePassword(data: AccountChangePasswordData): Pr
     .where(eq(tables.users.id, userId))
 }
 
+/**
+ * Change self account general information
+ *
+ * @param data
+ * @returns void
+ */
 export async function changeGeneralInfo(data: AccountGeneralData): Promise<void> {
   const db = useDatabase()
   const changeGeneralInfoSchema = z.object({
@@ -71,6 +83,12 @@ export async function changeGeneralInfo(data: AccountGeneralData): Promise<void>
     .where(eq(tables.users.id, userId))
 }
 
+/**
+ * Delete self account
+ *
+ * @param data
+ * @returns void
+ */
 export async function accountDelete(data: AccountDeleteData): Promise<void> {
   const db = useDatabase()
   const deleteAccountSchema = z.object({