Improve function doc comment for type hinting

Seneca-CDOT · Jan 18, 2022 · dce6df5 · dce6df5
1 parent d0bc474
commit dce6df5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 7 deletions.
diff --git a/src/api/posts/src/data/post.js b/src/api/posts/src/data/post.js
@@ -36,11 +36,8 @@ function ensureFeed(feed) {
 }
 
 /**
- * Determine the type of the post depending on the given URL.
- * The possible types are 'video' or 'blogpost'.
- *
  * @param {string} url
- * @returns {string} the post's type
+ * @returns {"video" | "blogpost"} the post's type
  */
 function determinePostType(url) {
   try {

diff --git a/src/backend/data/post.js b/src/backend/data/post.js
@@ -40,10 +40,8 @@ function ensureFeed(feed) {
 }
 
 /**
- * The possible types are 'video' or 'blogpost'.
- *
  * @param {string} url
- * @returns {string} the post's type
+ * @returns {"video" | "blogpost"} the post's type
  */
 function determinePostType(url) {
   try {