Add JSDocs to ContactUs

amsnyder · Nov 6, 2019 · 547af7f · 547af7f
1 parent 2a6ad82
commit 547af7f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/services/contact-us.js b/services/contact-us.js
@@ -2,6 +2,12 @@
 import { WRIAPI } from 'utils/axios';
 import { logger } from 'utils/logs';
 
+/**
+ * Sends a contact form including a topic, email address, and a message.
+ * Check out the API docs for this endpoint {@link https://resource-watch.github.io/doc-api/index-rw.html#contact-us|here}
+ * @param {Object} params Request paremeters to API.
+ * @returns {Promise}
+ */
 export const contactUs = (params) => {
   logger.info('Contact us');
   return WRIAPI.post('contact-us', params)