From 7b01c9e69a60e51079394b31a4821873cc410c88 Mon Sep 17 00:00:00 2001
From: dDogge <>
Date: Fri, 15 Dec 2023 12:07:24 +0100
Subject: [PATCH] Added comments to NewPostContainer

---
 src/components/NewPostContainer.tsx | 44 +++++++++++++++++++++++++++--
 1 file changed, 42 insertions(+), 2 deletions(-)

diff --git a/src/components/NewPostContainer.tsx b/src/components/NewPostContainer.tsx
index b475d2d..882124b 100644
--- a/src/components/NewPostContainer.tsx
+++ b/src/components/NewPostContainer.tsx
@@ -3,12 +3,30 @@ import { View, Text, TextInput, Button } from "react-native";
 import { style } from "../util/style";
 import { createPost, NewPost, submitLogin } from "../util/api";
 
+/**
+ * NewPostContainer component for handling new post creation.
+ *
+ * @component
+ * @param {object} props - React component props.
+ * @param {object} props.navigation - Navigation object for navigating between screens.
+ * @returns {JSX.Element} - Rendered NewPostContainer component.
+ */
 export function NewPostContainer({ navigation }): JSX.Element {
+  /**
+   * State hook for managing the current input text.
+   * @type {[string, React.Dispatch<React.SetStateAction<string>>]}
+   */
   const [currentInput, setCurrentInput] = React.useState<string>("");
+
+  /**
+   * State hook for managing the current input error message.
+   * @type {[string, React.Dispatch<React.SetStateAction<string>>]}
+   */
   const [currentInputError, setCurrentInputError] = React.useState<string>("");
 
   return (
     <View style={style.newPostContainer}>
+      {/* Input field for the new post */}
       <TextInput
         style={style.newPostInput}
         placeholder="New Post"
@@ -18,28 +36,50 @@ export function NewPostContainer({ navigation }): JSX.Element {
         }}
         value={currentInput}
       />
+
+      {/* Button to submit the new post */}
       <Button
         title="Post"
         onPress={() => {
+          /**
+           * Asynchronously submits the new post.
+           *
+           * @async
+           * @function
+           * @returns {Promise<void>} - A Promise that resolves when the post is successfully submitted.
+           */
           async function submit(): Promise<void> {
+            // Submit login to obtain user token
             const user = (await submitLogin("demouser", "demopw")) ?? {
               token: "",
             };
-            const p: NewPost = {
+
+            // Create new post object
+            const newPost: NewPost = {
               content: currentInput,
               token: user.token,
             };
-            await createPost(p);
+
+            // Call API to create the post
+            await createPost(newPost);
+
+            // Reset the input field
             setCurrentInput("");
           }
+
+          // Check if the input is not empty before submitting
           if (currentInput.length > 0) {
             submit();
+            // Navigate to the Home screen after successful post submission
             navigation.navigate("Home");
           } else {
+            // Set an error message if the input is empty
             setCurrentInputError("Post must not be empty!");
           }
         }}
       />
+
+      {/* Display error message if there's any */}
       <Text style={style.errorText}>{currentInputError}</Text>
     </View>
   );