docs(jsdoc): add comments for generateTextEmailFromHTML

Add JSDoc comments for genearteTextEmailFromHTML utility Resolves #61 Signed-off-by: Niloy Sikdar <[email protected]>
leopardslab · Aug 12, 2022 · 2491ebf · 2491ebf
1 parent 709a2eb
commit 2491ebf
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/utils/generateTextEmailFromHTML/generateTextEmailFromHTML.ts b/src/utils/generateTextEmailFromHTML/generateTextEmailFromHTML.ts
@@ -1,5 +1,11 @@
 import htmlToPlainText from 'textversionjs';
 
+/**
+ * Function to convert HTML Email to Text version.
+ * @param {string}  html - HTML which needs to be converted.
+ * @returns {string} Text version of the email in string format.
+ */
+
 export const generateTextEmailFromHTML = (html: string): string => {
   const plainText = htmlToPlainText(html, { headingStyle: 'hashify' });
   return plainText;