Add temp JSDoc to the function

medic · Nov 5, 2024 · 9c34fcf · 9c34fcf
1 parent 72489e8
commit 9c34fcf
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/contact-summary/contact-summary-emitter.js b/src/contact-summary/contact-summary-emitter.js
@@ -1,3 +1,19 @@
+/**
+ * @param contactSummary {{
+ *   fields: {
+ *     appliesToType: string[] | undefined,
+ *     appliesIf: () => boolean | undefined,
+ *   }[] | undefined,
+ *   context: object | undefined,
+ *   cards: {
+ *     appliesToType: string[] | undefined,
+ *     appliesIf: (report: object) => boolean | boolean | undefined,
+ *   }[] | undefined,
+ * }}
+ * @param contact {object}
+ * @param reports {object[]}
+ * @returns {{cards: object[], fields: object[]}}
+ */
 function emitter(contactSummary, contact, reports) {
   var fields = contactSummary.fields || [];
   var context = contactSummary.context || {};