Add some comments and TSDoc documentation

Author: lulunac27a

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-app",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -33,4 +33,4 @@
   "gitHooks": {
     "pre-commit": "lint-staged"
   }
-}
+}

src/components/NewTodo.vue

@@ -64,16 +64,16 @@ import { difficulty, priority, repeatFrequency } from "./TodoList.vue";
 import { defineComponent } from "vue";
 
 export interface todoTask {
-  task: string;
-  dueDate: Date;
-  priority: number;
-  difficulty: number;
-  repeatOften: number;
-  repeatFrequency: number;
-  newId: number;
-  completed: boolean;
-  timesCompleted: number;
-  originalDueDate: Date;
+  task: string; //task name
+  dueDate: Date; //task due date
+  priority: number; //task priority
+  difficulty: number; //task difficulty
+  repeatOften: number; //task repetition number of days/weeks/months/years
+  repeatFrequency: number; //task repetition frequency
+  newId: number; //task id
+  completed: boolean; //task completed or not
+  timesCompleted: number; //times task has been completed
+  originalDueDate: Date; //task original due date
 }
 const currentUtcDate: Date = new Date();
 const currentLocalDate: Date = new Date(
@@ -102,6 +102,9 @@ export default defineComponent({
     dueDateInput.min = currentLocalDate.toISOString().split("T")[0]; //minimum due date must be today
   },
   methods: {
+    /**
+     * Add task to todo list when user presses the Add Todo button.
+     */
     addTodo: function (): void | todoTask[] {
       this.dueDate = this.originalDueDate; //set task due date to entered task original due date
       store.dispatch("createTask", this);

src/components/TodoList.vue

@@ -96,9 +96,17 @@ export default defineComponent({
     },
   },
   methods: {
+    /**
+     * Complete task based on task ID.
+     * @param id task id
+     */
     completeTodo: function (id: number) {
       store.dispatch("completeTask", id);
     },
+    /**
+     * Delete task based on task ID.
+     * @param id task id
+     */
     deleteTodo: function (id: number) {
       store.dispatch("deleteTask", id);
     },

src/store/index.ts

@@ -18,6 +18,9 @@ export default createStore({
     getProgress: (state) => state.user.progress, //get user level progress
   },
   mutations: {
+    /**
+     * Update user XP state when user presses Complete button to complete the task.
+     */
     updateXp: (state, payload) => {
       const task = state.todos.find(
         (todo: { newId: number }) => todo.newId === payload
@@ -88,6 +91,9 @@ export default createStore({
         100; //calculate level progress and if level is 1 set total xp at the start of level 1 to 0 xp
     },
     create_Todo: (state, payload) => {
+      /**
+       * Create the task when user presses the Add Todo button.
+       */
       const createTask = {
         newId: payload.newId as number,
         task: payload.task as string,
@@ -104,6 +110,9 @@ export default createStore({
       state.todos.unshift(createTask);
     },
     complete_Todo: (state, payload) => {
+      /**
+       * Complete the task when user presses the Complete button.
+       */
       const item = state.todos.find(
         (todo: { newId: number }) => todo.newId === payload
       );
@@ -237,6 +246,9 @@ export default createStore({
       }
     },
     delete_Todo: (state, payload) => {
+      /**
+       * Delete the task when user confirms task deletion alert after pressing the Delete button.
+       */
       const index = state.todos.findIndex(
         (todo: { newId: number }) => todo.newId === payload
       );
@@ -256,35 +268,58 @@ export default createStore({
       state.user = user; //set user data
     },
     setTodos: (state, todos) => {
-      state.todos = todos; //set user data
+      state.todos = todos; //set todos data
     },
   },
   actions: {
     createTask: (context, payload) => {
+      /**
+       * Action to create the task.
+       */
       context.commit("create_Todo", payload);
     },
     completeTask: (context, payload) => {
+      /**
+       * Action to complete the task.
+       */
       context.commit("complete_Todo", payload);
       context.commit("updateXp", payload);
     },
     deleteTask: (context, payload) => {
+      /**
+       * Action to delete the task.
+       */
       context.commit("delete_Todo", payload);
     },
     saveUser(context, user) {
+      /**
+       * Action to save user data to local storage.
+       * @param user the user data
+       */
       localStorage.setItem("user", JSON.stringify(user)); //save user data
       context.commit("setUser", user);
     },
     loadUser(context) {
+      /**
+       * Action to load user data from local storage.
+       */
       const user = JSON.parse(localStorage.getItem("user") as string); //load user data
       if (user) {
         context.commit("setUser", user);
       }
     },
     saveTodos(context, todos) {
+      /**
+       * Action to save task list data to local storage.
+       * @param todos the task list data
+       */
       localStorage.setItem("todos", JSON.stringify(todos)); //save task list data
       context.commit("setTodos", todos);
     },
     loadTodos(context) {
+      /**
+       * Action to load task list data to local storage.
+       */
       const todos = JSON.parse(localStorage.getItem("todos") as string); //load task list data
       if (todos) {
         context.commit("setTodos", todos);