Add JSDoc to source file (#130)

jgarber623 · web-flow · commit 9261dcd0c81c · 2023-10-14T15:56:03.000-04:00
diff --git a/src/cashcash.js b/src/cashcash.js
@@ -23,6 +23,12 @@ class Cash {
   }
 }
 
+/**
+ * @param {string} selector Any valid CSS selector.
+ * @param {string|HTMLElement} context Optional search context.
+ *
+ * @returns {Cash} An instance of the Cash class
+ */
 export default function CashCash(selector, context) {
   return new Cash(selector, context);
 }

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,12 @@ class Cash {`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`
	`26`	`+/**`
	`27`	`+ * @param {string} selector Any valid CSS selector.`
	`28`	`+ * @param {string\|HTMLElement} context Optional search context.`
	`29`	`+ *`
	`30`	`+ * @returns {Cash} An instance of the Cash class`
	`31`	`+ */`
`26`	`32`	`export default function CashCash(selector, context) {`
`27`	`33`	`return new Cash(selector, context);`
`28`	`34`	`}`