feat(docs): Add JSDocs to exported functions

fb55 · fb55 · commit 6b60fa9e8da0 · 2020-10-09T12:13:57.000-07:00
diff --git a/readme.md b/readme.md
@@ -25,11 +25,11 @@ CSSwhat.parse("foo[bar]:baz")
 
 ## API
 
-**`CSSwhat.parse(str, options)` - Parses `str`, optionally with the passed `options`.**
+**`CSSwhat.parse(selector, options)` - Parses `selector`, optionally with the passed `options`.**
 
 The function returns a two-dimensional array. The first array represents selectors separated by commas (eg. `sub1, sub2`), the second contains the relevant tokens for that selector. Possible token types are:
 
-| name             | attributes                              | example       | output                                                                                   |
+| name             | properties                              | example       | output                                                                                   |
 | ---------------- | --------------------------------------- | ------------- | ---------------------------------------------------------------------------------------- |
 | `tag`            | `name`                                  | `div`         | `{ type: 'tag', name: 'div' }`                                                           |
 | `universal`      | -                                       | `*`           | `{ type: 'universal' }`                                                                  |
diff --git a/src/parse.ts b/src/parse.ts
@@ -1,10 +1,18 @@
-"use strict";
-
-export default parse;
-
 export interface Options {
+    /**
+     * When false, tag names will not be lowercased.
+     * @default true
+     */
     lowerCaseAttributeNames?: boolean;
+    /**
+     * When false, attribute names will not be lowercased.
+     * @default true
+     */
     lowerCaseTags?: boolean;
+    /**
+     * When `true`, `xmlMode` implies both `lowerCaseTags` and `lowerCaseAttributeNames` are set to `false`.
+     * @default false
+     */
     xmlMode?: boolean;
 }
 
@@ -131,7 +139,19 @@ function isWhitespace(c: string) {
     return c === " " || c === "\n" || c === "\t" || c === "\f" || c === "\r";
 }
 
-function parse(selector: string, options?: Options): Selector[][] {
+/**
+ * Parses `selector`, optionally with the passed `options`.
+ *
+ * @param selector Selector to parse.
+ * @param options Options for parsing.
+ * @returns Returns a two-dimensional array.
+ * The first dimension represents selectors separated by commas (eg. `sub1, sub2`),
+ * the second contains the relevant tokens for that selector.
+ */
+export default function parse(
+    selector: string,
+    options?: Options
+): Selector[][] {
     const subselects: Selector[][] = [];
 
     selector = parseSelector(subselects, `${selector}`, options);
diff --git a/src/stringify.ts b/src/stringify.ts
@@ -21,8 +21,13 @@ const charsToEscape = new Set([
     "\\",
 ]);
 
-export default function stringify(token: Selector[][]): string {
-    return token.map(stringifySubselector).join(", ");
+/**
+ * Turns `selector` back into a string.
+ *
+ * @param selector Selector to stringify.
+ */
+export default function stringify(selector: Selector[][]): string {
+    return selector.map(stringifySubselector).join(", ");
 }
 
 function stringifySubselector(token: Selector[]): string {
