[action] JSDoc documentation generated on 2025-01-18T11:02:08Z

Author: github-actions[bot]

docs/Post.html

@@ -648,13 +648,13 @@ <h4 class="name" id="logout"><span class="type-signature"></span>logout<span cla
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-routes_auth.html">routes/auth</a></li><li><a href="module-routes_index.html">routes/index</a></li></ul><h3>Classes</h3><ul><li><a href="Session.html">Session</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cookieMiddleware">cookieMiddleware</a></li><li><a href="global.html#errorHandler">errorHandler</a></li><li><a href="global.html#generateSessionId">generateSessionId</a></li><li><a href="global.html#loggerMiddleware">loggerMiddleware</a></li><li><a href="global.html#notFoundHandler">notFoundHandler</a></li><li><a href="global.html#parseCookies">parseCookies</a></li><li><a href="global.html#router">router</a></li><li><a href="global.html#sessionMiddleware">sessionMiddleware</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-routes_auth.html">routes/auth</a></li><li><a href="module-routes_index.html">routes/index</a></li></ul><h3>Classes</h3><ul><li><a href="Post.html">Post</a></li><li><a href="Session.html">Session</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ADMIN">ADMIN</a></li><li><a href="global.html#AUTHOR">AUTHOR</a></li><li><a href="global.html#cookieMiddleware">cookieMiddleware</a></li><li><a href="global.html#errorHandler">errorHandler</a></li><li><a href="global.html#generateSessionId">generateSessionId</a></li><li><a href="global.html#loggerMiddleware">loggerMiddleware</a></li><li><a href="global.html#notFoundHandler">notFoundHandler</a></li><li><a href="global.html#parseCookies">parseCookies</a></li><li><a href="global.html#router">router</a></li><li><a href="global.html#sessionMiddleware">sessionMiddleware</a></li><li><a href="global.html#USER">USER</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 17 2025 13:53:18 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sat Jan 18 2025 11:02:08 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/Session.html

@@ -28,7 +28,7 @@ <h1 class="page-title">Class: User</h1>
 
 <header>
 
-        <h2><span class="attribs"><span class="type-signature"></span></span>User<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>User<span class="signature">(username, email, role)</span><span class="type-signature"></span></h2>
 
             <div class="class-description">User class</div>
 
@@ -45,7 +45,7 @@ <h2>Constructor</h2>
 
 
 
-    <h4 class="name" id="User"><span class="type-signature"></span>new User<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="User"><span class="type-signature"></span>new User<span class="signature">(username, email, role)</span><span class="type-signature"></span></h4>
 
 
 
@@ -60,6 +60,101 @@ <h4 class="name" id="User"><span class="type-signature"></span>new User<span cla
 
 
 
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>username</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>email</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>role</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="global.html#Role">Role</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
 
 
 
@@ -93,7 +188,7 @@ <h4 class="name" id="User"><span class="type-signature"></span>new User<span cla
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line9">line 9</a>
+        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line28">line 28</a>
     </li></ul></dd>
 
 
@@ -193,7 +288,75 @@ <h5>Type:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line14">line 14</a>
+        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line38">line 38</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="role"><span class="type-signature"></span>role<span class="type-signature"> :<a href="global.html#Role">Role</a></span></h4>
+
+
+
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type"><a href="global.html#Role">Role</a></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line40">line 40</a>
     </li></ul></dd>
 
 
@@ -261,7 +424,7 @@ <h5>Type:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line12">line 12</a>
+        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line36">line 36</a>
     </li></ul></dd>
 
 
@@ -289,7 +452,7 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id=".loginUser"><span class="type-signature">(async, static) </span>loginUser<span class="signature">(username, password)</span><span class="type-signature"> &rarr; {Promise.&lt;(*|null)>}</span></h4>
+    <h4 class="name" id=".loginUser"><span class="type-signature">(async, static) </span>loginUser<span class="signature">(username, password)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="User.html">User</a>|null)>}</span></h4>
 
 
 
@@ -403,7 +566,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line23">line 23</a>
+        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line49">line 49</a>
     </li></ul></dd>
 
 
@@ -439,7 +602,7 @@ <h5>Returns:</h5>
     </dt>
     <dd>
 
-<span class="param-type">Promise.&lt;(*|null)></span>
+<span class="param-type">Promise.&lt;(<a href="User.html">User</a>|null)></span>
 
 
     </dd>
@@ -553,7 +716,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line44">line 44</a>
+        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line70">line 70</a>
     </li></ul></dd>
 
 
@@ -617,13 +780,13 @@ <h5>Returns:</h5>
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-routes_auth.html">routes/auth</a></li><li><a href="module-routes_index.html">routes/index</a></li></ul><h3>Classes</h3><ul><li><a href="Session.html">Session</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cookieMiddleware">cookieMiddleware</a></li><li><a href="global.html#errorHandler">errorHandler</a></li><li><a href="global.html#generateSessionId">generateSessionId</a></li><li><a href="global.html#loggerMiddleware">loggerMiddleware</a></li><li><a href="global.html#notFoundHandler">notFoundHandler</a></li><li><a href="global.html#parseCookies">parseCookies</a></li><li><a href="global.html#router">router</a></li><li><a href="global.html#sessionMiddleware">sessionMiddleware</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-routes_auth.html">routes/auth</a></li><li><a href="module-routes_index.html">routes/index</a></li></ul><h3>Classes</h3><ul><li><a href="Post.html">Post</a></li><li><a href="Session.html">Session</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ADMIN">ADMIN</a></li><li><a href="global.html#AUTHOR">AUTHOR</a></li><li><a href="global.html#cookieMiddleware">cookieMiddleware</a></li><li><a href="global.html#errorHandler">errorHandler</a></li><li><a href="global.html#generateSessionId">generateSessionId</a></li><li><a href="global.html#loggerMiddleware">loggerMiddleware</a></li><li><a href="global.html#notFoundHandler">notFoundHandler</a></li><li><a href="global.html#parseCookies">parseCookies</a></li><li><a href="global.html#router">router</a></li><li><a href="global.html#sessionMiddleware">sessionMiddleware</a></li><li><a href="global.html#USER">USER</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 17 2025 13:53:18 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sat Jan 18 2025 11:02:08 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>