add a DocBlock for BadgeFactory.create()

badges · Oct 25, 2018 · cb94899 · cb94899
1 parent 38fa253
commit cb94899
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/lib/gh-badges.js b/lib/gh-badges.js
@@ -10,6 +10,19 @@ class BadgeFactory {
       : new PDFKitTextMeasurer(fontPath, fallbackFontPath)
   }
 
+  /**
+   * Create a badge
+   *
+   * @param {object} format - Object specifying badge data
+   * @param {string[]} format.text
+   * @param {string} format.colorscheme
+   * @param {string} format.colorA
+   * @param {string} format.colorB
+   * @param {string} format.format
+   * @param {string} format.template
+   * @return {string} Badge in SVG or JSON format
+   * @see https://github.com/badges/shields/blob/master/doc/gh-badges.md
+   */
   create(format) {
     return makeBadge(this.measurer, format)
   }