docs(hiccup-css): add doc strings for attrib fns

thi-ng · Mar 5, 2018 · 22bc29c · 22bc29c
1 parent 721583a
commit 22bc29c
Showing 1 changed file with 45 additions and 0 deletions.
diff --git a/packages/hiccup-css/src/attribs.ts b/packages/hiccup-css/src/attribs.ts
@@ -1,7 +1,52 @@
 const $ = (op) => (id: string, x: string | number, caseSensitve = false) => `[${id}${op}="${x}"${caseSensitve ? " i" : ""}]`;
+
+/**
+ * Returns attrib selector: `[id]`
+ *
+ * @param id
+ */
 export const withAttrib = (id: string) => `[${id}]`;
+
+/**
+ * Returns attrib selector `[id=x]`
+ *
+ * @param id
+ * @param x
+ * @param caseSensitive
+ */
 export const attribEq = $("");
+
+/**
+ * Returns attrib selector `[id~=x]`
+ *
+ * @param id
+ * @param x
+ * @param caseSensitive
+ */
 export const attribContains = $("~");
+
+/**
+ * Returns attrib selector `[id^=x]`
+ *
+ * @param id
+ * @param x
+ * @param caseSensitive
+ */
 export const attribPrefix = $("^");
+
+/**
+ * Returns attrib selector `[id$=x]`
+ *
+ * @param id
+ * @param x
+ * @param caseSensitive
+ */
 export const attribSuffix = $("$");
+
+/**
+ * Returns attrib selector `[id*=x]`
+ * @param id
+ * @param x
+ * @param caseSensitive
+ */
 export const attribMatches = $("*");