New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
badges - npm Package Compare versions
Comparing version 1.2.5 to 1.2.6
@@ -13,11 +13,12 @@ 'use strict'; | ||
| /** | ||
| Generate a HTML badge | ||
| @private | ||
| @method badge | ||
| @param {String} config.image The URL to the image | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Generate a HTML badge | ||
| * @private | ||
| * @method badge | ||
| * @param {Object} opts | ||
| * @param {string} opts.image The URL to the image | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function badge(_ref) { | ||
@@ -42,12 +43,13 @@ var image = _ref.image, | ||
| /** | ||
| Shields Custom Badge | ||
| @method shields | ||
| @param {String} config.left The text for the left side of the badge | ||
| @param {String} config.right The text for the right side of the badge | ||
| @param {String} [config.color='yellow'] The color for the badge | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Shields Custom Badge | ||
| * @method shields | ||
| * @param {Object} opts | ||
| * @param {string} opts.left The text for the left side of the badge | ||
| * @param {string} opts.right The text for the right side of the badge | ||
| * @param {string} [opts.color='yellow'] The color for the badge | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function shields(_ref2) { | ||
@@ -76,7 +78,8 @@ var left = _ref2.left, | ||
| /** | ||
| NPM Version Badge | ||
| @method npmversion | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Version Badge | ||
| * @method npmversion | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmversion(_ref3) { | ||
@@ -98,7 +101,8 @@ var npmPackageName = _ref3.npmPackageName; | ||
| /** | ||
| NPM Downloads Badge | ||
| @method npmdownloads | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Downloads Badge | ||
| * @method npmdownloads | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmdownloads(_ref4) { | ||
@@ -119,7 +123,8 @@ var npmPackageName = _ref4.npmPackageName; | ||
| /** | ||
| David DM Dependencies Badge | ||
| @method daviddm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dependencies Badge | ||
| * @method daviddm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddm(_ref5) { | ||
@@ -141,7 +146,8 @@ var githubSlug = _ref5.githubSlug; | ||
| /** | ||
| David DM Dev Dependencies Badge | ||
| @method daviddmdev | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dev Dependencies Badge | ||
| * @method daviddmdev | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddmdev(_ref6) { | ||
@@ -163,10 +169,11 @@ var githubSlug = _ref6.githubSlug; | ||
| /** | ||
| Nodei.co Badge | ||
| @method nodeico | ||
| @param {String} config.npmPackageName | ||
| @param {String|Object} [config.nodeicoQueryString] See https://nodei.co for options | ||
| * Nodei.co Badge | ||
| * @method nodeico | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName | ||
| * @param {String|Object} [opts.nodeicoQueryString] See https://nodei.co for options | ||
| defined as either a string param1=¶m2= | ||
| or an object {param1: '', param2: ''} that will be serialized to param1=¶m2= etc. | ||
| @return {String} the result badge | ||
| */ | ||
| * @return {string} the result badge | ||
| */ | ||
| function nodeico(_ref7) { | ||
@@ -197,7 +204,8 @@ var npmPackageName = _ref7.npmPackageName, | ||
| /** | ||
| Sauce Labs Browser Matrix Badge | ||
| @method saucelabsbm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Browser Matrix Badge | ||
| * @method saucelabsbm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabsbm(_ref8) { | ||
@@ -223,8 +231,9 @@ var saucelabsUsername = _ref8.saucelabsUsername, | ||
| /** | ||
| Sauce Labs Badge | ||
| @method saucelabs | ||
| @param {String} config.saucelabsUsername The saucelabs username | ||
| @param {String} config.saucelabsAuthToken The saucelabs authorisation token | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Badge | ||
| * @method saucelabs | ||
| * @param {Object} opts | ||
| * @param {string} opts.saucelabsUsername The saucelabs username | ||
| * @param {string} opts.saucelabsAuthToken The saucelabs authorisation token | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabs(_ref9) { | ||
@@ -249,7 +258,8 @@ var saucelabsUsername = _ref9.saucelabsUsername, | ||
| /** | ||
| Travis CI Badge | ||
| @method travisci | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Travis CI Badge | ||
| * @method travisci | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function travisci(_ref10) { | ||
@@ -271,8 +281,9 @@ var githubSlug = _ref10.githubSlug; | ||
| /** | ||
| Codeship Badge | ||
| @method codeship | ||
| @param {String} config.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| @param {String} config.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| @return {String} the result badge | ||
| */ | ||
| * Codeship Badge | ||
| * @method codeship | ||
| * @param {Object} opts | ||
| * @param {string} opts.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| * @param {string} opts.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeship(_ref11) { | ||
@@ -296,7 +307,8 @@ var codeshipProjectUUID = _ref11.codeshipProjectUUID, | ||
| /** | ||
| Coveralls Badge | ||
| @method coveralls | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Coveralls Badge | ||
| * @method coveralls | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function coveralls(_ref12) { | ||
@@ -318,7 +330,8 @@ var githubSlug = _ref12.githubSlug; | ||
| /** | ||
| Code Climate Rating Badge | ||
| @method codeclimate | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Code Climate Rating Badge | ||
| * @method codeclimate | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeclimate(_ref13) { | ||
@@ -340,7 +353,8 @@ var githubSlug = _ref13.githubSlug; | ||
| /** | ||
| BitHound Score Badge | ||
| @method bithound | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * BitHound Score Badge | ||
| * @method bithound | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function bithound(_ref14) { | ||
@@ -362,7 +376,8 @@ var githubSlug = _ref14.githubSlug; | ||
| /** | ||
| Waffle Badge | ||
| @method waffle | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Waffle Badge | ||
| * @method waffle | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function waffle(_ref15) { | ||
@@ -388,8 +403,9 @@ var githubSlug = _ref15.githubSlug; | ||
| /** | ||
| 60devs Tips Badge | ||
| @method sixtydevstips | ||
| @param {String} config.sixtydevsUsername The 60devs username to donate to | ||
| @param {String} config.sixtydevstipsURL The url to the 60devs donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * 60devs Tips Badge | ||
| * @method sixtydevstips | ||
| * @param {Object} opts | ||
| * @param {string} opts.sixtydevsUsername The 60devs username to donate to | ||
| * @param {string} opts.sixtydevstipsURL The url to the 60devs donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function sixtydevstips(_ref16) { | ||
@@ -415,8 +431,9 @@ var sixtydevstipsID = _ref16.sixtydevstipsID, | ||
| /** | ||
| Patreon Badge | ||
| @method patreon | ||
| @param {String} config.patreonUsername The Patreon username to donate to | ||
| @param {String} config.patreonURL The url to the Patreon donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Patreon Badge | ||
| * @method patreon | ||
| * @param {Object} opts | ||
| * @param {string} opts.patreonUsername The Patreon username to donate to | ||
| * @param {string} opts.patreonURL The url to the Patreon donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function patreon(_ref17) { | ||
@@ -442,8 +459,9 @@ var patreonUsername = _ref17.patreonUsername, | ||
| /** | ||
| Open Collective Badge | ||
| @method opencollective | ||
| @param {String} config.opencollectiveUsername The Open Collective username to donate to | ||
| @param {String} config.opencollectiveURL The url to the Open Collective donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Open Collective Badge | ||
| * @method opencollective | ||
| * @param {Object} opts | ||
| * @param {string} opts.opencollectiveUsername The Open Collective username to donate to | ||
| * @param {string} opts.opencollectiveURL The url to the Open Collective donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function opencollective(_ref18) { | ||
@@ -469,8 +487,9 @@ var opencollectiveUsername = _ref18.opencollectiveUsername, | ||
| /** | ||
| Gratipay Badge | ||
| @method gratipay | ||
| @param {String} config.gratipayUsername The Gratipay username to donate to | ||
| @param {String} config.gratipayURL The url to the Gratipay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Gratipay Badge | ||
| * @method gratipay | ||
| * @param {Object} opts | ||
| * @param {string} opts.gratipayUsername The Gratipay username to donate to | ||
| * @param {string} opts.gratipayURL The url to the Gratipay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function gratipay(_ref19) { | ||
@@ -496,9 +515,10 @@ var gratipayUsername = _ref19.gratipayUsername, | ||
| /** | ||
| Flattr Badge | ||
| @method flattr | ||
| @param {String} config.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| @param {String} config.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| @param {String} config.flattrURL The url to the flattr donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Flattr Badge | ||
| * @method flattr | ||
| * @param {Object} opts | ||
| * @param {string} opts.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| * @param {string} opts.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| * @param {string} opts.flattrURL The url to the flattr donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function flattr(_ref20) { | ||
@@ -530,9 +550,10 @@ var flattrCode = _ref20.flattrCode, | ||
| /** | ||
| Paypal Badge | ||
| @method paypal | ||
| @param {String} config.paypalURL The url to the paypal donate page | ||
| @param {String} config.paypalButtonID The Paypal button id | ||
| @param {String} config.paypalUsername The Paypal.me username | ||
| @return {String} the result badge | ||
| */ | ||
| * Paypal Badge | ||
| * @method paypal | ||
| * @param {Object} opts | ||
| * @param {string} opts.paypalURL The url to the paypal donate page | ||
| * @param {string} opts.paypalButtonID The Paypal button id | ||
| * @param {string} opts.paypalUsername The Paypal.me username | ||
| * @return {string} the result badge | ||
| */ | ||
| function paypal(_ref21) { | ||
@@ -564,7 +585,8 @@ var paypalURL = _ref21.paypalURL, | ||
| /** | ||
| Bitcoin Badge | ||
| @method bitcoin | ||
| @param {String} config.bitcoinURL The url to the bitcoin donation page | ||
| @return {String} the result badge | ||
| */ | ||
| * Bitcoin Badge | ||
| * @method bitcoin | ||
| * @param {Object} opts | ||
| * @param {string} opts.bitcoinURL The url to the bitcoin donation page | ||
| * @return {string} the result badge | ||
| */ | ||
| function bitcoin(_ref22) { | ||
@@ -586,7 +608,8 @@ var bitcoinURL = _ref22.bitcoinURL; | ||
| /** | ||
| Wishlist Badge | ||
| @method wishlist | ||
| @param {String} config.wishlistURL The url to the wishlist page | ||
| @return {String} the result badge | ||
| */ | ||
| * Wishlist Badge | ||
| * @method wishlist | ||
| * @param {Object} opts | ||
| * @param {string} opts.wishlistURL The url to the wishlist page | ||
| * @return {string} the result badge | ||
| */ | ||
| function wishlist(_ref23) { | ||
@@ -608,8 +631,9 @@ var wishlistURL = _ref23.wishlistURL; | ||
| /** | ||
| Buy Me A Coffee Badge | ||
| @method buymeacoffee | ||
| @param {String} config.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| @param {String} config.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Buy Me A Coffee Badge | ||
| * @method buymeacoffee | ||
| * @param {Object} opts | ||
| * @param {string} opts.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| * @param {string} opts.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function buymeacoffee(_ref24) { | ||
@@ -635,8 +659,9 @@ var buymeacoffeeUsername = _ref24.buymeacoffeeUsername, | ||
| /** | ||
| Liberapay Badge | ||
| @method liberapay | ||
| @param {String} config.liberapayUsername The Liberapay username to donate to | ||
| @param {String} config.liberapayURL The url to the Liberapay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Liberapay Badge | ||
| * @method liberapay | ||
| * @param {Object} opts | ||
| * @param {string} opts.liberapayUsername The Liberapay username to donate to | ||
| * @param {string} opts.liberapayURL The url to the Liberapay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function liberapay(_ref25) { | ||
@@ -662,8 +687,9 @@ var liberapayUsername = _ref25.liberapayUsername, | ||
| /** | ||
| Thanks App Badge | ||
| @method thanksapp | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * Thanks App Badge | ||
| * @method thanksapp | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function thanksapp(_ref26) { | ||
@@ -687,7 +713,8 @@ var githubSlug = _ref26.githubSlug, | ||
| /** | ||
| Boost Lab Badge | ||
| @method boostlab | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Boost Lab Badge | ||
| * @method boostlab | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function boostlab(_ref27) { | ||
@@ -712,7 +739,8 @@ var githubSlug = _ref27.githubSlug; | ||
| /** | ||
| Slackin Script Badge | ||
| @method slackinscript | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Script Badge | ||
| * @method slackinscript | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackinscript(_ref28) { | ||
@@ -731,7 +759,8 @@ var slackinURL = _ref28.slackinURL; | ||
| /** | ||
| Slackin Badge | ||
| @method slackin | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Badge | ||
| * @method slackin | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackin(_ref29) { | ||
@@ -753,9 +782,10 @@ var slackinURL = _ref29.slackinURL; | ||
| /** | ||
| Google Analytics Beacon Badge | ||
| * Google Analytics Beacon Badge | ||
| https://github.com/igrigorik/ga-beacon | ||
| @method gabeacon | ||
| @param {String} config.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * @method gabeacon | ||
| @param {Object} opts | ||
| * @param {string} opts.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function gabeacon(_ref30) { | ||
@@ -779,7 +809,8 @@ var gaTrackingID = _ref30.gaTrackingID, | ||
| /** | ||
| Google Plus One Button | ||
| @method googleplusone | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Google Plus One Button | ||
| * @method googleplusone | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function googleplusone(_ref31) { | ||
@@ -798,7 +829,8 @@ var homepage = _ref31.homepage; | ||
| /** | ||
| Reddit Submit Button | ||
| @method redditsubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Reddit Submit Button | ||
| * @method redditsubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function redditsubmit(_ref32) { | ||
@@ -817,7 +849,8 @@ var homepage = _ref32.homepage; | ||
| /** | ||
| Hacker News Submit Button | ||
| @method hackernewssubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Hacker News Submit Button | ||
| * @method hackernewssubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function hackernewssubmit(_ref33) { | ||
@@ -836,8 +869,9 @@ var homepage = _ref33.homepage; | ||
| /** | ||
| Facebook Like Button | ||
| @method facebooklike | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Like Button | ||
| * @method facebooklike | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebooklike(_ref34) { | ||
@@ -859,8 +893,9 @@ var homepage = _ref34.homepage, | ||
| /** | ||
| Facebook Follow Button | ||
| @method facebookfollow | ||
| @param {String} config.facebookUsername The facebook username to follow | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Follow Button | ||
| * @method facebookfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.facebookUsername The facebook username to follow | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebookfollow(_ref35) { | ||
@@ -882,7 +917,8 @@ var facebookUsername = _ref35.facebookUsername, | ||
| /** | ||
| Twitter Tweet Button | ||
| @method twittertweet | ||
| @param {String} config.twitterUsername The twitter username to tweet at | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Tweet Button | ||
| * @method twittertweet | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to tweet at | ||
| * @return {string} the result badge | ||
| */ | ||
| function twittertweet(_ref36) { | ||
@@ -901,7 +937,8 @@ var twitterUsername = _ref36.twitterUsername; | ||
| /** | ||
| Twitter Follow Button | ||
| @method twitterfollow | ||
| @param {String} config.twitterUsername The twitter username to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Follow Button | ||
| * @method twitterfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function twitterfollow(_ref37) { | ||
@@ -920,7 +957,8 @@ var twitterUsername = _ref37.twitterUsername; | ||
| /** | ||
| Github Follow Button | ||
| @method githubfollow | ||
| @param {String} config.githubUsername The github user to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Github Follow Button | ||
| * @method githubfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubUsername The github user to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubfollow(_ref38) { | ||
@@ -939,7 +977,8 @@ var githubUsername = _ref38.githubUsername; | ||
| /** | ||
| GitHub Star Button | ||
| @method githubstar | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * GitHub Star Button | ||
| * @method githubstar | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubstar(_ref39) { | ||
@@ -962,9 +1001,10 @@ var githubSlug = _ref39.githubSlug; | ||
| /** | ||
| Quora Follow Button | ||
| @method quorafollow | ||
| @param {String} config.quoraUsername The quora user to follow | ||
| @param {String} [config.quoraRealname] The quora user's name | ||
| @param {String} [config.quoraCode] Some code | ||
| @return {String} the result badge | ||
| */ | ||
| * Quora Follow Button | ||
| * @method quorafollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.quoraUsername The quora user to follow | ||
| * @param {string} [opts.quoraRealname] The quora user's name | ||
| * @param {string} [opts.quoraCode] Some code | ||
| * @return {string} the result badge | ||
| */ | ||
| function quorafollow(_ref40) { | ||
@@ -971,0 +1011,0 @@ var quoraUsername = _ref40.quoraUsername, |
@@ -13,11 +13,12 @@ 'use strict'; | ||
| /** | ||
| Generate a HTML badge | ||
| @private | ||
| @method badge | ||
| @param {String} config.image The URL to the image | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Generate a HTML badge | ||
| * @private | ||
| * @method badge | ||
| * @param {Object} opts | ||
| * @param {string} opts.image The URL to the image | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function badge(_ref) { | ||
@@ -42,12 +43,13 @@ var image = _ref.image, | ||
| /** | ||
| Shields Custom Badge | ||
| @method shields | ||
| @param {String} config.left The text for the left side of the badge | ||
| @param {String} config.right The text for the right side of the badge | ||
| @param {String} [config.color='yellow'] The color for the badge | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Shields Custom Badge | ||
| * @method shields | ||
| * @param {Object} opts | ||
| * @param {string} opts.left The text for the left side of the badge | ||
| * @param {string} opts.right The text for the right side of the badge | ||
| * @param {string} [opts.color='yellow'] The color for the badge | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function shields(_ref2) { | ||
@@ -76,7 +78,8 @@ var left = _ref2.left, | ||
| /** | ||
| NPM Version Badge | ||
| @method npmversion | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Version Badge | ||
| * @method npmversion | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmversion(_ref3) { | ||
@@ -98,7 +101,8 @@ var npmPackageName = _ref3.npmPackageName; | ||
| /** | ||
| NPM Downloads Badge | ||
| @method npmdownloads | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Downloads Badge | ||
| * @method npmdownloads | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmdownloads(_ref4) { | ||
@@ -119,7 +123,8 @@ var npmPackageName = _ref4.npmPackageName; | ||
| /** | ||
| David DM Dependencies Badge | ||
| @method daviddm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dependencies Badge | ||
| * @method daviddm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddm(_ref5) { | ||
@@ -141,7 +146,8 @@ var githubSlug = _ref5.githubSlug; | ||
| /** | ||
| David DM Dev Dependencies Badge | ||
| @method daviddmdev | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dev Dependencies Badge | ||
| * @method daviddmdev | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddmdev(_ref6) { | ||
@@ -163,10 +169,11 @@ var githubSlug = _ref6.githubSlug; | ||
| /** | ||
| Nodei.co Badge | ||
| @method nodeico | ||
| @param {String} config.npmPackageName | ||
| @param {String|Object} [config.nodeicoQueryString] See https://nodei.co for options | ||
| * Nodei.co Badge | ||
| * @method nodeico | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName | ||
| * @param {String|Object} [opts.nodeicoQueryString] See https://nodei.co for options | ||
| defined as either a string param1=¶m2= | ||
| or an object {param1: '', param2: ''} that will be serialized to param1=¶m2= etc. | ||
| @return {String} the result badge | ||
| */ | ||
| * @return {string} the result badge | ||
| */ | ||
| function nodeico(_ref7) { | ||
@@ -197,7 +204,8 @@ var npmPackageName = _ref7.npmPackageName, | ||
| /** | ||
| Sauce Labs Browser Matrix Badge | ||
| @method saucelabsbm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Browser Matrix Badge | ||
| * @method saucelabsbm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabsbm(_ref8) { | ||
@@ -223,8 +231,9 @@ var saucelabsUsername = _ref8.saucelabsUsername, | ||
| /** | ||
| Sauce Labs Badge | ||
| @method saucelabs | ||
| @param {String} config.saucelabsUsername The saucelabs username | ||
| @param {String} config.saucelabsAuthToken The saucelabs authorisation token | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Badge | ||
| * @method saucelabs | ||
| * @param {Object} opts | ||
| * @param {string} opts.saucelabsUsername The saucelabs username | ||
| * @param {string} opts.saucelabsAuthToken The saucelabs authorisation token | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabs(_ref9) { | ||
@@ -249,7 +258,8 @@ var saucelabsUsername = _ref9.saucelabsUsername, | ||
| /** | ||
| Travis CI Badge | ||
| @method travisci | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Travis CI Badge | ||
| * @method travisci | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function travisci(_ref10) { | ||
@@ -271,8 +281,9 @@ var githubSlug = _ref10.githubSlug; | ||
| /** | ||
| Codeship Badge | ||
| @method codeship | ||
| @param {String} config.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| @param {String} config.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| @return {String} the result badge | ||
| */ | ||
| * Codeship Badge | ||
| * @method codeship | ||
| * @param {Object} opts | ||
| * @param {string} opts.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| * @param {string} opts.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeship(_ref11) { | ||
@@ -296,7 +307,8 @@ var codeshipProjectUUID = _ref11.codeshipProjectUUID, | ||
| /** | ||
| Coveralls Badge | ||
| @method coveralls | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Coveralls Badge | ||
| * @method coveralls | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function coveralls(_ref12) { | ||
@@ -318,7 +330,8 @@ var githubSlug = _ref12.githubSlug; | ||
| /** | ||
| Code Climate Rating Badge | ||
| @method codeclimate | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Code Climate Rating Badge | ||
| * @method codeclimate | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeclimate(_ref13) { | ||
@@ -340,7 +353,8 @@ var githubSlug = _ref13.githubSlug; | ||
| /** | ||
| BitHound Score Badge | ||
| @method bithound | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * BitHound Score Badge | ||
| * @method bithound | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function bithound(_ref14) { | ||
@@ -362,7 +376,8 @@ var githubSlug = _ref14.githubSlug; | ||
| /** | ||
| Waffle Badge | ||
| @method waffle | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Waffle Badge | ||
| * @method waffle | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function waffle(_ref15) { | ||
@@ -388,8 +403,9 @@ var githubSlug = _ref15.githubSlug; | ||
| /** | ||
| 60devs Tips Badge | ||
| @method sixtydevstips | ||
| @param {String} config.sixtydevsUsername The 60devs username to donate to | ||
| @param {String} config.sixtydevstipsURL The url to the 60devs donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * 60devs Tips Badge | ||
| * @method sixtydevstips | ||
| * @param {Object} opts | ||
| * @param {string} opts.sixtydevsUsername The 60devs username to donate to | ||
| * @param {string} opts.sixtydevstipsURL The url to the 60devs donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function sixtydevstips(_ref16) { | ||
@@ -415,8 +431,9 @@ var sixtydevstipsID = _ref16.sixtydevstipsID, | ||
| /** | ||
| Patreon Badge | ||
| @method patreon | ||
| @param {String} config.patreonUsername The Patreon username to donate to | ||
| @param {String} config.patreonURL The url to the Patreon donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Patreon Badge | ||
| * @method patreon | ||
| * @param {Object} opts | ||
| * @param {string} opts.patreonUsername The Patreon username to donate to | ||
| * @param {string} opts.patreonURL The url to the Patreon donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function patreon(_ref17) { | ||
@@ -442,8 +459,9 @@ var patreonUsername = _ref17.patreonUsername, | ||
| /** | ||
| Open Collective Badge | ||
| @method opencollective | ||
| @param {String} config.opencollectiveUsername The Open Collective username to donate to | ||
| @param {String} config.opencollectiveURL The url to the Open Collective donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Open Collective Badge | ||
| * @method opencollective | ||
| * @param {Object} opts | ||
| * @param {string} opts.opencollectiveUsername The Open Collective username to donate to | ||
| * @param {string} opts.opencollectiveURL The url to the Open Collective donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function opencollective(_ref18) { | ||
@@ -469,8 +487,9 @@ var opencollectiveUsername = _ref18.opencollectiveUsername, | ||
| /** | ||
| Gratipay Badge | ||
| @method gratipay | ||
| @param {String} config.gratipayUsername The Gratipay username to donate to | ||
| @param {String} config.gratipayURL The url to the Gratipay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Gratipay Badge | ||
| * @method gratipay | ||
| * @param {Object} opts | ||
| * @param {string} opts.gratipayUsername The Gratipay username to donate to | ||
| * @param {string} opts.gratipayURL The url to the Gratipay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function gratipay(_ref19) { | ||
@@ -496,9 +515,10 @@ var gratipayUsername = _ref19.gratipayUsername, | ||
| /** | ||
| Flattr Badge | ||
| @method flattr | ||
| @param {String} config.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| @param {String} config.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| @param {String} config.flattrURL The url to the flattr donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Flattr Badge | ||
| * @method flattr | ||
| * @param {Object} opts | ||
| * @param {string} opts.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| * @param {string} opts.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| * @param {string} opts.flattrURL The url to the flattr donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function flattr(_ref20) { | ||
@@ -530,9 +550,10 @@ var flattrCode = _ref20.flattrCode, | ||
| /** | ||
| Paypal Badge | ||
| @method paypal | ||
| @param {String} config.paypalURL The url to the paypal donate page | ||
| @param {String} config.paypalButtonID The Paypal button id | ||
| @param {String} config.paypalUsername The Paypal.me username | ||
| @return {String} the result badge | ||
| */ | ||
| * Paypal Badge | ||
| * @method paypal | ||
| * @param {Object} opts | ||
| * @param {string} opts.paypalURL The url to the paypal donate page | ||
| * @param {string} opts.paypalButtonID The Paypal button id | ||
| * @param {string} opts.paypalUsername The Paypal.me username | ||
| * @return {string} the result badge | ||
| */ | ||
| function paypal(_ref21) { | ||
@@ -564,7 +585,8 @@ var paypalURL = _ref21.paypalURL, | ||
| /** | ||
| Bitcoin Badge | ||
| @method bitcoin | ||
| @param {String} config.bitcoinURL The url to the bitcoin donation page | ||
| @return {String} the result badge | ||
| */ | ||
| * Bitcoin Badge | ||
| * @method bitcoin | ||
| * @param {Object} opts | ||
| * @param {string} opts.bitcoinURL The url to the bitcoin donation page | ||
| * @return {string} the result badge | ||
| */ | ||
| function bitcoin(_ref22) { | ||
@@ -586,7 +608,8 @@ var bitcoinURL = _ref22.bitcoinURL; | ||
| /** | ||
| Wishlist Badge | ||
| @method wishlist | ||
| @param {String} config.wishlistURL The url to the wishlist page | ||
| @return {String} the result badge | ||
| */ | ||
| * Wishlist Badge | ||
| * @method wishlist | ||
| * @param {Object} opts | ||
| * @param {string} opts.wishlistURL The url to the wishlist page | ||
| * @return {string} the result badge | ||
| */ | ||
| function wishlist(_ref23) { | ||
@@ -608,8 +631,9 @@ var wishlistURL = _ref23.wishlistURL; | ||
| /** | ||
| Buy Me A Coffee Badge | ||
| @method buymeacoffee | ||
| @param {String} config.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| @param {String} config.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Buy Me A Coffee Badge | ||
| * @method buymeacoffee | ||
| * @param {Object} opts | ||
| * @param {string} opts.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| * @param {string} opts.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function buymeacoffee(_ref24) { | ||
@@ -635,8 +659,9 @@ var buymeacoffeeUsername = _ref24.buymeacoffeeUsername, | ||
| /** | ||
| Liberapay Badge | ||
| @method liberapay | ||
| @param {String} config.liberapayUsername The Liberapay username to donate to | ||
| @param {String} config.liberapayURL The url to the Liberapay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Liberapay Badge | ||
| * @method liberapay | ||
| * @param {Object} opts | ||
| * @param {string} opts.liberapayUsername The Liberapay username to donate to | ||
| * @param {string} opts.liberapayURL The url to the Liberapay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function liberapay(_ref25) { | ||
@@ -662,8 +687,9 @@ var liberapayUsername = _ref25.liberapayUsername, | ||
| /** | ||
| Thanks App Badge | ||
| @method thanksapp | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * Thanks App Badge | ||
| * @method thanksapp | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function thanksapp(_ref26) { | ||
@@ -687,7 +713,8 @@ var githubSlug = _ref26.githubSlug, | ||
| /** | ||
| Boost Lab Badge | ||
| @method boostlab | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Boost Lab Badge | ||
| * @method boostlab | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function boostlab(_ref27) { | ||
@@ -712,7 +739,8 @@ var githubSlug = _ref27.githubSlug; | ||
| /** | ||
| Slackin Script Badge | ||
| @method slackinscript | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Script Badge | ||
| * @method slackinscript | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackinscript(_ref28) { | ||
@@ -731,7 +759,8 @@ var slackinURL = _ref28.slackinURL; | ||
| /** | ||
| Slackin Badge | ||
| @method slackin | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Badge | ||
| * @method slackin | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackin(_ref29) { | ||
@@ -753,9 +782,10 @@ var slackinURL = _ref29.slackinURL; | ||
| /** | ||
| Google Analytics Beacon Badge | ||
| * Google Analytics Beacon Badge | ||
| https://github.com/igrigorik/ga-beacon | ||
| @method gabeacon | ||
| @param {String} config.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * @method gabeacon | ||
| @param {Object} opts | ||
| * @param {string} opts.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function gabeacon(_ref30) { | ||
@@ -779,7 +809,8 @@ var gaTrackingID = _ref30.gaTrackingID, | ||
| /** | ||
| Google Plus One Button | ||
| @method googleplusone | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Google Plus One Button | ||
| * @method googleplusone | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function googleplusone(_ref31) { | ||
@@ -798,7 +829,8 @@ var homepage = _ref31.homepage; | ||
| /** | ||
| Reddit Submit Button | ||
| @method redditsubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Reddit Submit Button | ||
| * @method redditsubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function redditsubmit(_ref32) { | ||
@@ -817,7 +849,8 @@ var homepage = _ref32.homepage; | ||
| /** | ||
| Hacker News Submit Button | ||
| @method hackernewssubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Hacker News Submit Button | ||
| * @method hackernewssubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function hackernewssubmit(_ref33) { | ||
@@ -836,8 +869,9 @@ var homepage = _ref33.homepage; | ||
| /** | ||
| Facebook Like Button | ||
| @method facebooklike | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Like Button | ||
| * @method facebooklike | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebooklike(_ref34) { | ||
@@ -859,8 +893,9 @@ var homepage = _ref34.homepage, | ||
| /** | ||
| Facebook Follow Button | ||
| @method facebookfollow | ||
| @param {String} config.facebookUsername The facebook username to follow | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Follow Button | ||
| * @method facebookfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.facebookUsername The facebook username to follow | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebookfollow(_ref35) { | ||
@@ -882,7 +917,8 @@ var facebookUsername = _ref35.facebookUsername, | ||
| /** | ||
| Twitter Tweet Button | ||
| @method twittertweet | ||
| @param {String} config.twitterUsername The twitter username to tweet at | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Tweet Button | ||
| * @method twittertweet | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to tweet at | ||
| * @return {string} the result badge | ||
| */ | ||
| function twittertweet(_ref36) { | ||
@@ -901,7 +937,8 @@ var twitterUsername = _ref36.twitterUsername; | ||
| /** | ||
| Twitter Follow Button | ||
| @method twitterfollow | ||
| @param {String} config.twitterUsername The twitter username to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Follow Button | ||
| * @method twitterfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function twitterfollow(_ref37) { | ||
@@ -920,7 +957,8 @@ var twitterUsername = _ref37.twitterUsername; | ||
| /** | ||
| Github Follow Button | ||
| @method githubfollow | ||
| @param {String} config.githubUsername The github user to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Github Follow Button | ||
| * @method githubfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubUsername The github user to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubfollow(_ref38) { | ||
@@ -939,7 +977,8 @@ var githubUsername = _ref38.githubUsername; | ||
| /** | ||
| GitHub Star Button | ||
| @method githubstar | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * GitHub Star Button | ||
| * @method githubstar | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubstar(_ref39) { | ||
@@ -962,9 +1001,10 @@ var githubSlug = _ref39.githubSlug; | ||
| /** | ||
| Quora Follow Button | ||
| @method quorafollow | ||
| @param {String} config.quoraUsername The quora user to follow | ||
| @param {String} [config.quoraRealname] The quora user's name | ||
| @param {String} [config.quoraCode] Some code | ||
| @return {String} the result badge | ||
| */ | ||
| * Quora Follow Button | ||
| * @method quorafollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.quoraUsername The quora user to follow | ||
| * @param {string} [opts.quoraRealname] The quora user's name | ||
| * @param {string} [opts.quoraCode] Some code | ||
| * @return {string} the result badge | ||
| */ | ||
| function quorafollow(_ref40) { | ||
@@ -971,0 +1011,0 @@ var quoraUsername = _ref40.quoraUsername, |
@@ -11,11 +11,12 @@ 'use strict'; | ||
| /** | ||
| Generate a HTML badge | ||
| @private | ||
| @method badge | ||
| @param {String} config.image The URL to the image | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Generate a HTML badge | ||
| * @private | ||
| * @method badge | ||
| * @param {Object} opts | ||
| * @param {string} opts.image The URL to the image | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function badge({ image, alt, url, title }) { | ||
@@ -35,12 +36,13 @@ // Check | ||
| /** | ||
| Shields Custom Badge | ||
| @method shields | ||
| @param {String} config.left The text for the left side of the badge | ||
| @param {String} config.right The text for the right side of the badge | ||
| @param {String} [config.color='yellow'] The color for the badge | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Shields Custom Badge | ||
| * @method shields | ||
| * @param {Object} opts | ||
| * @param {string} opts.left The text for the left side of the badge | ||
| * @param {string} opts.right The text for the right side of the badge | ||
| * @param {string} [opts.color='yellow'] The color for the badge | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function shields({ left, right, color = 'yellow', alt, url, title }) { | ||
@@ -61,7 +63,8 @@ // Check | ||
| /** | ||
| NPM Version Badge | ||
| @method npmversion | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Version Badge | ||
| * @method npmversion | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmversion({ npmPackageName }) { | ||
@@ -81,7 +84,8 @@ // Check | ||
| /** | ||
| NPM Downloads Badge | ||
| @method npmdownloads | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Downloads Badge | ||
| * @method npmdownloads | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmdownloads({ npmPackageName }) { | ||
@@ -100,7 +104,8 @@ // Check | ||
| /** | ||
| David DM Dependencies Badge | ||
| @method daviddm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dependencies Badge | ||
| * @method daviddm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddm({ githubSlug }) { | ||
@@ -120,7 +125,8 @@ // Check | ||
| /** | ||
| David DM Dev Dependencies Badge | ||
| @method daviddmdev | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dev Dependencies Badge | ||
| * @method daviddmdev | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddmdev({ githubSlug }) { | ||
@@ -140,10 +146,11 @@ // Check | ||
| /** | ||
| Nodei.co Badge | ||
| @method nodeico | ||
| @param {String} config.npmPackageName | ||
| @param {String|Object} [config.nodeicoQueryString] See https://nodei.co for options | ||
| * Nodei.co Badge | ||
| * @method nodeico | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName | ||
| * @param {String|Object} [opts.nodeicoQueryString] See https://nodei.co for options | ||
| defined as either a string param1=¶m2= | ||
| or an object {param1: '', param2: ''} that will be serialized to param1=¶m2= etc. | ||
| @return {String} the result badge | ||
| */ | ||
| * @return {string} the result badge | ||
| */ | ||
| function nodeico({ npmPackageName, nodeicoQueryString }) { | ||
@@ -171,7 +178,8 @@ // Prepare | ||
| /** | ||
| Sauce Labs Browser Matrix Badge | ||
| @method saucelabsbm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Browser Matrix Badge | ||
| * @method saucelabsbm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabsbm({ saucelabsUsername, saucelabsAuthToken }) { | ||
@@ -194,8 +202,9 @@ // Check | ||
| /** | ||
| Sauce Labs Badge | ||
| @method saucelabs | ||
| @param {String} config.saucelabsUsername The saucelabs username | ||
| @param {String} config.saucelabsAuthToken The saucelabs authorisation token | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Badge | ||
| * @method saucelabs | ||
| * @param {Object} opts | ||
| * @param {string} opts.saucelabsUsername The saucelabs username | ||
| * @param {string} opts.saucelabsAuthToken The saucelabs authorisation token | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabs({ saucelabsUsername, saucelabsAuthToken }) { | ||
@@ -217,7 +226,8 @@ // Check | ||
| /** | ||
| Travis CI Badge | ||
| @method travisci | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Travis CI Badge | ||
| * @method travisci | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function travisci({ githubSlug }) { | ||
@@ -237,8 +247,9 @@ // Check | ||
| /** | ||
| Codeship Badge | ||
| @method codeship | ||
| @param {String} config.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| @param {String} config.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| @return {String} the result badge | ||
| */ | ||
| * Codeship Badge | ||
| * @method codeship | ||
| * @param {Object} opts | ||
| * @param {string} opts.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| * @param {string} opts.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeship({ codeshipProjectUUID, codeshipProjectID }) { | ||
@@ -259,7 +270,8 @@ // Check | ||
| /** | ||
| Coveralls Badge | ||
| @method coveralls | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Coveralls Badge | ||
| * @method coveralls | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function coveralls({ githubSlug }) { | ||
@@ -279,7 +291,8 @@ // Check | ||
| /** | ||
| Code Climate Rating Badge | ||
| @method codeclimate | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Code Climate Rating Badge | ||
| * @method codeclimate | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeclimate({ githubSlug }) { | ||
@@ -299,7 +312,8 @@ // Check | ||
| /** | ||
| BitHound Score Badge | ||
| @method bithound | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * BitHound Score Badge | ||
| * @method bithound | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function bithound({ githubSlug }) { | ||
@@ -319,7 +333,8 @@ // Check | ||
| /** | ||
| Waffle Badge | ||
| @method waffle | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Waffle Badge | ||
| * @method waffle | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function waffle({ githubSlug }) { | ||
@@ -343,8 +358,9 @@ // Check | ||
| /** | ||
| 60devs Tips Badge | ||
| @method sixtydevstips | ||
| @param {String} config.sixtydevsUsername The 60devs username to donate to | ||
| @param {String} config.sixtydevstipsURL The url to the 60devs donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * 60devs Tips Badge | ||
| * @method sixtydevstips | ||
| * @param {Object} opts | ||
| * @param {string} opts.sixtydevsUsername The 60devs username to donate to | ||
| * @param {string} opts.sixtydevstipsURL The url to the 60devs donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function sixtydevstips({ sixtydevstipsID, sixtydevstipsURL }) { | ||
@@ -367,8 +383,9 @@ // Check | ||
| /** | ||
| Patreon Badge | ||
| @method patreon | ||
| @param {String} config.patreonUsername The Patreon username to donate to | ||
| @param {String} config.patreonURL The url to the Patreon donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Patreon Badge | ||
| * @method patreon | ||
| * @param {Object} opts | ||
| * @param {string} opts.patreonUsername The Patreon username to donate to | ||
| * @param {string} opts.patreonURL The url to the Patreon donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function patreon({ patreonUsername, patreonURL }) { | ||
@@ -391,8 +408,9 @@ // Check | ||
| /** | ||
| Open Collective Badge | ||
| @method opencollective | ||
| @param {String} config.opencollectiveUsername The Open Collective username to donate to | ||
| @param {String} config.opencollectiveURL The url to the Open Collective donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Open Collective Badge | ||
| * @method opencollective | ||
| * @param {Object} opts | ||
| * @param {string} opts.opencollectiveUsername The Open Collective username to donate to | ||
| * @param {string} opts.opencollectiveURL The url to the Open Collective donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function opencollective({ opencollectiveUsername, opencollectiveURL }) { | ||
@@ -415,8 +433,9 @@ // Check | ||
| /** | ||
| Gratipay Badge | ||
| @method gratipay | ||
| @param {String} config.gratipayUsername The Gratipay username to donate to | ||
| @param {String} config.gratipayURL The url to the Gratipay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Gratipay Badge | ||
| * @method gratipay | ||
| * @param {Object} opts | ||
| * @param {string} opts.gratipayUsername The Gratipay username to donate to | ||
| * @param {string} opts.gratipayURL The url to the Gratipay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function gratipay({ gratipayUsername, gratipayURL }) { | ||
@@ -439,9 +458,10 @@ // Check | ||
| /** | ||
| Flattr Badge | ||
| @method flattr | ||
| @param {String} config.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| @param {String} config.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| @param {String} config.flattrURL The url to the flattr donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Flattr Badge | ||
| * @method flattr | ||
| * @param {Object} opts | ||
| * @param {string} opts.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| * @param {string} opts.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| * @param {string} opts.flattrURL The url to the flattr donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function flattr({ flattrCode, flattrUsername, flattrURL }) { | ||
@@ -469,9 +489,10 @@ // Check | ||
| /** | ||
| Paypal Badge | ||
| @method paypal | ||
| @param {String} config.paypalURL The url to the paypal donate page | ||
| @param {String} config.paypalButtonID The Paypal button id | ||
| @param {String} config.paypalUsername The Paypal.me username | ||
| @return {String} the result badge | ||
| */ | ||
| * Paypal Badge | ||
| * @method paypal | ||
| * @param {Object} opts | ||
| * @param {string} opts.paypalURL The url to the paypal donate page | ||
| * @param {string} opts.paypalButtonID The Paypal button id | ||
| * @param {string} opts.paypalUsername The Paypal.me username | ||
| * @return {string} the result badge | ||
| */ | ||
| function paypal({ paypalURL, paypalButtonID, paypalUsername }) { | ||
@@ -499,7 +520,8 @@ // Check | ||
| /** | ||
| Bitcoin Badge | ||
| @method bitcoin | ||
| @param {String} config.bitcoinURL The url to the bitcoin donation page | ||
| @return {String} the result badge | ||
| */ | ||
| * Bitcoin Badge | ||
| * @method bitcoin | ||
| * @param {Object} opts | ||
| * @param {string} opts.bitcoinURL The url to the bitcoin donation page | ||
| * @return {string} the result badge | ||
| */ | ||
| function bitcoin({ bitcoinURL }) { | ||
@@ -519,7 +541,8 @@ // Check | ||
| /** | ||
| Wishlist Badge | ||
| @method wishlist | ||
| @param {String} config.wishlistURL The url to the wishlist page | ||
| @return {String} the result badge | ||
| */ | ||
| * Wishlist Badge | ||
| * @method wishlist | ||
| * @param {Object} opts | ||
| * @param {string} opts.wishlistURL The url to the wishlist page | ||
| * @return {string} the result badge | ||
| */ | ||
| function wishlist({ wishlistURL }) { | ||
@@ -539,8 +562,9 @@ // Check | ||
| /** | ||
| Buy Me A Coffee Badge | ||
| @method buymeacoffee | ||
| @param {String} config.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| @param {String} config.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Buy Me A Coffee Badge | ||
| * @method buymeacoffee | ||
| * @param {Object} opts | ||
| * @param {string} opts.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| * @param {string} opts.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function buymeacoffee({ buymeacoffeeUsername, buymeacoffeeURL }) { | ||
@@ -563,8 +587,9 @@ // Check | ||
| /** | ||
| Liberapay Badge | ||
| @method liberapay | ||
| @param {String} config.liberapayUsername The Liberapay username to donate to | ||
| @param {String} config.liberapayURL The url to the Liberapay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Liberapay Badge | ||
| * @method liberapay | ||
| * @param {Object} opts | ||
| * @param {string} opts.liberapayUsername The Liberapay username to donate to | ||
| * @param {string} opts.liberapayURL The url to the Liberapay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function liberapay({ liberapayUsername, liberapayURL }) { | ||
@@ -587,8 +612,9 @@ // Check | ||
| /** | ||
| Thanks App Badge | ||
| @method thanksapp | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * Thanks App Badge | ||
| * @method thanksapp | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function thanksapp({ githubSlug, npmPackageName }) { | ||
@@ -609,7 +635,8 @@ // Check | ||
| /** | ||
| Boost Lab Badge | ||
| @method boostlab | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Boost Lab Badge | ||
| * @method boostlab | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function boostlab({ githubSlug }) { | ||
@@ -632,7 +659,8 @@ // Check | ||
| /** | ||
| Slackin Script Badge | ||
| @method slackinscript | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Script Badge | ||
| * @method slackinscript | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackinscript({ slackinURL }) { | ||
@@ -649,7 +677,8 @@ // Check | ||
| /** | ||
| Slackin Badge | ||
| @method slackin | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Badge | ||
| * @method slackin | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackin({ slackinURL }) { | ||
@@ -669,9 +698,10 @@ // Check | ||
| /** | ||
| Google Analytics Beacon Badge | ||
| * Google Analytics Beacon Badge | ||
| https://github.com/igrigorik/ga-beacon | ||
| @method gabeacon | ||
| @param {String} config.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * @method gabeacon | ||
| @param {Object} opts | ||
| * @param {string} opts.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function gabeacon({ gaTrackingID, githubSlug }) { | ||
@@ -692,7 +722,8 @@ // Check | ||
| /** | ||
| Google Plus One Button | ||
| @method googleplusone | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Google Plus One Button | ||
| * @method googleplusone | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function googleplusone({ homepage }) { | ||
@@ -709,7 +740,8 @@ // Check | ||
| /** | ||
| Reddit Submit Button | ||
| @method redditsubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Reddit Submit Button | ||
| * @method redditsubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function redditsubmit({ homepage }) { | ||
@@ -726,7 +758,8 @@ // Check | ||
| /** | ||
| Hacker News Submit Button | ||
| @method hackernewssubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Hacker News Submit Button | ||
| * @method hackernewssubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function hackernewssubmit({ homepage }) { | ||
@@ -743,8 +776,9 @@ // Check | ||
| /** | ||
| Facebook Like Button | ||
| @method facebooklike | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Like Button | ||
| * @method facebooklike | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebooklike({ homepage, facebookApplicationID }) { | ||
@@ -763,8 +797,9 @@ // Prepare | ||
| /** | ||
| Facebook Follow Button | ||
| @method facebookfollow | ||
| @param {String} config.facebookUsername The facebook username to follow | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Follow Button | ||
| * @method facebookfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.facebookUsername The facebook username to follow | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebookfollow({ facebookUsername, facebookApplicationID }) { | ||
@@ -783,7 +818,8 @@ // Prepare | ||
| /** | ||
| Twitter Tweet Button | ||
| @method twittertweet | ||
| @param {String} config.twitterUsername The twitter username to tweet at | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Tweet Button | ||
| * @method twittertweet | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to tweet at | ||
| * @return {string} the result badge | ||
| */ | ||
| function twittertweet({ twitterUsername }) { | ||
@@ -800,7 +836,8 @@ // Prepare | ||
| /** | ||
| Twitter Follow Button | ||
| @method twitterfollow | ||
| @param {String} config.twitterUsername The twitter username to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Follow Button | ||
| * @method twitterfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function twitterfollow({ twitterUsername }) { | ||
@@ -817,7 +854,8 @@ // Prepare | ||
| /** | ||
| Github Follow Button | ||
| @method githubfollow | ||
| @param {String} config.githubUsername The github user to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Github Follow Button | ||
| * @method githubfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubUsername The github user to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubfollow({ githubUsername }) { | ||
@@ -834,7 +872,8 @@ // Prepare | ||
| /** | ||
| GitHub Star Button | ||
| @method githubstar | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * GitHub Star Button | ||
| * @method githubstar | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubstar({ githubSlug }) { | ||
@@ -855,9 +894,10 @@ // Prepare | ||
| /** | ||
| Quora Follow Button | ||
| @method quorafollow | ||
| @param {String} config.quoraUsername The quora user to follow | ||
| @param {String} [config.quoraRealname] The quora user's name | ||
| @param {String} [config.quoraCode] Some code | ||
| @return {String} the result badge | ||
| */ | ||
| * Quora Follow Button | ||
| * @method quorafollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.quoraUsername The quora user to follow | ||
| * @param {string} [opts.quoraRealname] The quora user's name | ||
| * @param {string} [opts.quoraCode] Some code | ||
| * @return {string} the result badge | ||
| */ | ||
| function quorafollow({ quoraUsername, quoraRealname, quoraCode }) { | ||
@@ -864,0 +904,0 @@ // Prepare |
| # History | ||
| ## v1.2.6 2018 October 26 | ||
| - Fixed the documentation params for the badges | ||
| - Added the new funding badges from v1.2.5 to the readme | ||
| ## v1.2.5 2018 October 26 | ||
@@ -4,0 +8,0 @@ - Added [Buy Me A Coffee](https://buymeacoffee.com) badge |
| { | ||
| "name": "badges", | ||
| "version": "1.2.5", | ||
| "version": "1.2.6", | ||
| "description": "The definitive collection of badges for rendering", | ||
@@ -73,4 +73,8 @@ "homepage": "https://github.com/bevry/badges", | ||
| "patreon", | ||
| "flattr", | ||
| "thanksapp", | ||
| "boostlab", | ||
| "opencollective", | ||
| "flattr", | ||
| "buymeacoffee", | ||
| "liberapay", | ||
| "paypal", | ||
@@ -82,2 +86,4 @@ "bitcoin", | ||
| "patreonUsername": "bevry", | ||
| "buymeacoffeeUsername": "balupton", | ||
| "liberapayUsername": "balupton", | ||
| "opencollectiveUsername": "bevry", | ||
@@ -84,0 +90,0 @@ "flattrUsername": "balupton", |
@@ -17,4 +17,8 @@ <!-- TITLE/ --> | ||
| <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> | ||
| <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span> | ||
| <span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/badges" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span> | ||
| <span class="badge-boostlab"><a href="https://boost-lab.app/bevry/badges" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span> | ||
| <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> | ||
| <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span> | ||
| <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> | ||
| <span class="badge-liberapay"><a href="https://liberapay.com/balupton" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> | ||
| <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> | ||
@@ -45,3 +49,3 @@ <span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span> | ||
| <li>Module: <code>require('badges')</code></li> | ||
| <li>CDN URL: <code>//wzrd.in/bundle/badges@1.2.5</code></li></ul> | ||
| <li>CDN URL: <code>//wzrd.in/bundle/badges@1.2.6</code></li></ul> | ||
@@ -68,3 +72,3 @@ <a href="http://enderjs.com" title="Ender is a full featured package manager for your browser"><h3>Ender</h3></a><ul> | ||
| ``` javascript | ||
| // Listing of the badges to output | ||
| // Listing of badges to output | ||
| const list = [ | ||
@@ -175,3 +179,3 @@ // Custom Badges | ||
| [Complete badge configuration available to you can be found here.](http://master.badges.bevry.surge.sh/docs/) | ||
| [Not all the badges are showcased in the above example. Browse the Complete API Documentation instead.](http://master.badges.bevry.surge.sh/docs/) | ||
@@ -226,4 +230,8 @@ | ||
| <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> | ||
| <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span> | ||
| <span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/badges" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span> | ||
| <span class="badge-boostlab"><a href="https://boost-lab.app/bevry/badges" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span> | ||
| <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> | ||
| <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span> | ||
| <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> | ||
| <span class="badge-liberapay"><a href="https://liberapay.com/balupton" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> | ||
| <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> | ||
@@ -230,0 +238,0 @@ <span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span> |
@@ -10,11 +10,12 @@ 'use strict' | ||
| /** | ||
| Generate a HTML badge | ||
| @private | ||
| @method badge | ||
| @param {String} config.image The URL to the image | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Generate a HTML badge | ||
| * @private | ||
| * @method badge | ||
| * @param {Object} opts | ||
| * @param {string} opts.image The URL to the image | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function badge ({ image, alt, url, title }) { | ||
@@ -34,12 +35,13 @@ // Check | ||
| /** | ||
| Shields Custom Badge | ||
| @method shields | ||
| @param {String} config.left The text for the left side of the badge | ||
| @param {String} config.right The text for the right side of the badge | ||
| @param {String} [config.color='yellow'] The color for the badge | ||
| @param {String} [config.alt] The alt attribute for the image | ||
| @param {String} [config.url] The URL for the link | ||
| @param {String} [config.title] The title attribute for the link | ||
| @return {String} the result badge | ||
| */ | ||
| * Shields Custom Badge | ||
| * @method shields | ||
| * @param {Object} opts | ||
| * @param {string} opts.left The text for the left side of the badge | ||
| * @param {string} opts.right The text for the right side of the badge | ||
| * @param {string} [opts.color='yellow'] The color for the badge | ||
| * @param {string} [opts.alt] The alt attribute for the image | ||
| * @param {string} [opts.url] The URL for the link | ||
| * @param {string} [opts.title] The title attribute for the link | ||
| * @return {string} the result badge | ||
| */ | ||
| function shields ({ left, right, color = 'yellow', alt, url, title }) { | ||
@@ -61,7 +63,8 @@ // Check | ||
| /** | ||
| NPM Version Badge | ||
| @method npmversion | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Version Badge | ||
| * @method npmversion | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmversion ({ npmPackageName }) { | ||
@@ -81,7 +84,8 @@ // Check | ||
| /** | ||
| NPM Downloads Badge | ||
| @method npmdownloads | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * NPM Downloads Badge | ||
| * @method npmdownloads | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function npmdownloads ({ npmPackageName }) { | ||
@@ -100,7 +104,8 @@ // Check | ||
| /** | ||
| David DM Dependencies Badge | ||
| @method daviddm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dependencies Badge | ||
| * @method daviddm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddm ({ githubSlug }) { | ||
@@ -120,7 +125,8 @@ // Check | ||
| /** | ||
| David DM Dev Dependencies Badge | ||
| @method daviddmdev | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * David DM Dev Dependencies Badge | ||
| * @method daviddmdev | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function daviddmdev ({ githubSlug }) { | ||
@@ -140,10 +146,11 @@ // Check | ||
| /** | ||
| Nodei.co Badge | ||
| @method nodeico | ||
| @param {String} config.npmPackageName | ||
| @param {String|Object} [config.nodeicoQueryString] See https://nodei.co for options | ||
| * Nodei.co Badge | ||
| * @method nodeico | ||
| * @param {Object} opts | ||
| * @param {string} opts.npmPackageName | ||
| * @param {String|Object} [opts.nodeicoQueryString] See https://nodei.co for options | ||
| defined as either a string param1=¶m2= | ||
| or an object {param1: '', param2: ''} that will be serialized to param1=¶m2= etc. | ||
| @return {String} the result badge | ||
| */ | ||
| * @return {string} the result badge | ||
| */ | ||
| function nodeico ({ npmPackageName, nodeicoQueryString }) { | ||
@@ -172,7 +179,8 @@ // Prepare | ||
| /** | ||
| Sauce Labs Browser Matrix Badge | ||
| @method saucelabsbm | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Browser Matrix Badge | ||
| * @method saucelabsbm | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabsbm ({ saucelabsUsername, saucelabsAuthToken }) { | ||
@@ -195,8 +203,9 @@ // Check | ||
| /** | ||
| Sauce Labs Badge | ||
| @method saucelabs | ||
| @param {String} config.saucelabsUsername The saucelabs username | ||
| @param {String} config.saucelabsAuthToken The saucelabs authorisation token | ||
| @return {String} the result badge | ||
| */ | ||
| * Sauce Labs Badge | ||
| * @method saucelabs | ||
| * @param {Object} opts | ||
| * @param {string} opts.saucelabsUsername The saucelabs username | ||
| * @param {string} opts.saucelabsAuthToken The saucelabs authorisation token | ||
| * @return {string} the result badge | ||
| */ | ||
| function saucelabs ({ saucelabsUsername, saucelabsAuthToken }) { | ||
@@ -218,7 +227,8 @@ // Check | ||
| /** | ||
| Travis CI Badge | ||
| @method travisci | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Travis CI Badge | ||
| * @method travisci | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function travisci ({ githubSlug }) { | ||
@@ -238,8 +248,9 @@ // Check | ||
| /** | ||
| Codeship Badge | ||
| @method codeship | ||
| @param {String} config.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| @param {String} config.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| @return {String} the result badge | ||
| */ | ||
| * Codeship Badge | ||
| * @method codeship | ||
| * @param {Object} opts | ||
| * @param {string} opts.codeshipProjectUUID The UUID for a specific project, which is available on the General tab in your project settings | ||
| * @param {string} opts.codeshipProjectID The ID for a specific project, which is available via the URL for the codeship project page | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeship ({ codeshipProjectUUID, codeshipProjectID }) { | ||
@@ -260,7 +271,8 @@ // Check | ||
| /** | ||
| Coveralls Badge | ||
| @method coveralls | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Coveralls Badge | ||
| * @method coveralls | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function coveralls ({ githubSlug }) { | ||
@@ -280,7 +292,8 @@ // Check | ||
| /** | ||
| Code Climate Rating Badge | ||
| @method codeclimate | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Code Climate Rating Badge | ||
| * @method codeclimate | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function codeclimate ({ githubSlug }) { | ||
@@ -300,7 +313,8 @@ // Check | ||
| /** | ||
| BitHound Score Badge | ||
| @method bithound | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * BitHound Score Badge | ||
| * @method bithound | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function bithound ({ githubSlug }) { | ||
@@ -320,7 +334,8 @@ // Check | ||
| /** | ||
| Waffle Badge | ||
| @method waffle | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Waffle Badge | ||
| * @method waffle | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function waffle ({ githubSlug }) { | ||
@@ -345,8 +360,9 @@ // Check | ||
| /** | ||
| 60devs Tips Badge | ||
| @method sixtydevstips | ||
| @param {String} config.sixtydevsUsername The 60devs username to donate to | ||
| @param {String} config.sixtydevstipsURL The url to the 60devs donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * 60devs Tips Badge | ||
| * @method sixtydevstips | ||
| * @param {Object} opts | ||
| * @param {string} opts.sixtydevsUsername The 60devs username to donate to | ||
| * @param {string} opts.sixtydevstipsURL The url to the 60devs donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function sixtydevstips ({ sixtydevstipsID, sixtydevstipsURL }) { | ||
@@ -369,8 +385,9 @@ // Check | ||
| /** | ||
| Patreon Badge | ||
| @method patreon | ||
| @param {String} config.patreonUsername The Patreon username to donate to | ||
| @param {String} config.patreonURL The url to the Patreon donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Patreon Badge | ||
| * @method patreon | ||
| * @param {Object} opts | ||
| * @param {string} opts.patreonUsername The Patreon username to donate to | ||
| * @param {string} opts.patreonURL The url to the Patreon donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function patreon ({ patreonUsername, patreonURL }) { | ||
@@ -393,8 +410,9 @@ // Check | ||
| /** | ||
| Open Collective Badge | ||
| @method opencollective | ||
| @param {String} config.opencollectiveUsername The Open Collective username to donate to | ||
| @param {String} config.opencollectiveURL The url to the Open Collective donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Open Collective Badge | ||
| * @method opencollective | ||
| * @param {Object} opts | ||
| * @param {string} opts.opencollectiveUsername The Open Collective username to donate to | ||
| * @param {string} opts.opencollectiveURL The url to the Open Collective donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function opencollective ({ opencollectiveUsername, opencollectiveURL }) { | ||
@@ -417,8 +435,9 @@ // Check | ||
| /** | ||
| Gratipay Badge | ||
| @method gratipay | ||
| @param {String} config.gratipayUsername The Gratipay username to donate to | ||
| @param {String} config.gratipayURL The url to the Gratipay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Gratipay Badge | ||
| * @method gratipay | ||
| * @param {Object} opts | ||
| * @param {string} opts.gratipayUsername The Gratipay username to donate to | ||
| * @param {string} opts.gratipayURL The url to the Gratipay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function gratipay ({ gratipayUsername, gratipayURL }) { | ||
@@ -441,9 +460,10 @@ // Check | ||
| /** | ||
| Flattr Badge | ||
| @method flattr | ||
| @param {String} config.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| @param {String} config.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| @param {String} config.flattrURL The url to the flattr donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Flattr Badge | ||
| * @method flattr | ||
| * @param {Object} opts | ||
| * @param {string} opts.flattrCode The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) | ||
| * @param {string} opts.flattrUsername The Flattr username to donate to (e.g. balupton) | ||
| * @param {string} opts.flattrURL The url to the flattr donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function flattr ({ flattrCode, flattrUsername, flattrURL }) { | ||
@@ -473,9 +493,10 @@ // Check | ||
| /** | ||
| Paypal Badge | ||
| @method paypal | ||
| @param {String} config.paypalURL The url to the paypal donate page | ||
| @param {String} config.paypalButtonID The Paypal button id | ||
| @param {String} config.paypalUsername The Paypal.me username | ||
| @return {String} the result badge | ||
| */ | ||
| * Paypal Badge | ||
| * @method paypal | ||
| * @param {Object} opts | ||
| * @param {string} opts.paypalURL The url to the paypal donate page | ||
| * @param {string} opts.paypalButtonID The Paypal button id | ||
| * @param {string} opts.paypalUsername The Paypal.me username | ||
| * @return {string} the result badge | ||
| */ | ||
| function paypal ({ paypalURL, paypalButtonID, paypalUsername }) { | ||
@@ -505,7 +526,8 @@ // Check | ||
| /** | ||
| Bitcoin Badge | ||
| @method bitcoin | ||
| @param {String} config.bitcoinURL The url to the bitcoin donation page | ||
| @return {String} the result badge | ||
| */ | ||
| * Bitcoin Badge | ||
| * @method bitcoin | ||
| * @param {Object} opts | ||
| * @param {string} opts.bitcoinURL The url to the bitcoin donation page | ||
| * @return {string} the result badge | ||
| */ | ||
| function bitcoin ({ bitcoinURL }) { | ||
@@ -525,7 +547,8 @@ // Check | ||
| /** | ||
| Wishlist Badge | ||
| @method wishlist | ||
| @param {String} config.wishlistURL The url to the wishlist page | ||
| @return {String} the result badge | ||
| */ | ||
| * Wishlist Badge | ||
| * @method wishlist | ||
| * @param {Object} opts | ||
| * @param {string} opts.wishlistURL The url to the wishlist page | ||
| * @return {string} the result badge | ||
| */ | ||
| function wishlist ({ wishlistURL }) { | ||
@@ -545,8 +568,9 @@ // Check | ||
| /** | ||
| Buy Me A Coffee Badge | ||
| @method buymeacoffee | ||
| @param {String} config.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| @param {String} config.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Buy Me A Coffee Badge | ||
| * @method buymeacoffee | ||
| * @param {Object} opts | ||
| * @param {string} opts.buymeacoffeeUsername The Buy Me A Coffee username to donate to | ||
| * @param {string} opts.buymeacoffeeURL The url to the Buy Me A Coffee donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function buymeacoffee ({ buymeacoffeeUsername, buymeacoffeeURL }) { | ||
@@ -569,8 +593,9 @@ // Check | ||
| /** | ||
| Liberapay Badge | ||
| @method liberapay | ||
| @param {String} config.liberapayUsername The Liberapay username to donate to | ||
| @param {String} config.liberapayURL The url to the Liberapay donate page | ||
| @return {String} the result badge | ||
| */ | ||
| * Liberapay Badge | ||
| * @method liberapay | ||
| * @param {Object} opts | ||
| * @param {string} opts.liberapayUsername The Liberapay username to donate to | ||
| * @param {string} opts.liberapayURL The url to the Liberapay donate page | ||
| * @return {string} the result badge | ||
| */ | ||
| function liberapay ({ liberapayUsername, liberapayURL }) { | ||
@@ -593,8 +618,9 @@ // Check | ||
| /** | ||
| Thanks App Badge | ||
| @method thanksapp | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @param {String} config.npmPackageName The repository slug (username/reponame) | ||
| @return {String} the result badge | ||
| */ | ||
| * Thanks App Badge | ||
| * @method thanksapp | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @param {string} opts.npmPackageName The repository slug (username/reponame) | ||
| * @return {string} the result badge | ||
| */ | ||
| function thanksapp ({ githubSlug, npmPackageName }) { | ||
@@ -615,7 +641,8 @@ // Check | ||
| /** | ||
| Boost Lab Badge | ||
| @method boostlab | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * Boost Lab Badge | ||
| * @method boostlab | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function boostlab ({ githubSlug }) { | ||
@@ -639,7 +666,8 @@ // Check | ||
| /** | ||
| Slackin Script Badge | ||
| @method slackinscript | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Script Badge | ||
| * @method slackinscript | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackinscript ({ slackinURL }) { | ||
@@ -656,7 +684,8 @@ // Check | ||
| /** | ||
| Slackin Badge | ||
| @method slackin | ||
| @param {String} config.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| @return {String} the result badge | ||
| */ | ||
| * Slackin Badge | ||
| * @method slackin | ||
| * @param {Object} opts | ||
| * @param {string} opts.slackinURL The slackin url (e.g. https://slack.bevry.me) | ||
| * @return {string} the result badge | ||
| */ | ||
| function slackin ({ slackinURL }) { | ||
@@ -676,9 +705,10 @@ // Check | ||
| /** | ||
| Google Analytics Beacon Badge | ||
| * Google Analytics Beacon Badge | ||
| https://github.com/igrigorik/ga-beacon | ||
| @method gabeacon | ||
| @param {String} config.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * @method gabeacon | ||
| @param {Object} opts | ||
| * @param {string} opts.gaTrackingID The google analytics tracing id (e.g. UA-XXXXX-XX) | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function gabeacon ({ gaTrackingID, githubSlug }) { | ||
@@ -699,7 +729,8 @@ // Check | ||
| /** | ||
| Google Plus One Button | ||
| @method googleplusone | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Google Plus One Button | ||
| * @method googleplusone | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function googleplusone ({ homepage }) { | ||
@@ -716,7 +747,8 @@ // Check | ||
| /** | ||
| Reddit Submit Button | ||
| @method redditsubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Reddit Submit Button | ||
| * @method redditsubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function redditsubmit ({ homepage }) { | ||
@@ -733,7 +765,8 @@ // Check | ||
| /** | ||
| Hacker News Submit Button | ||
| @method hackernewssubmit | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @return {String} the result badge | ||
| */ | ||
| * Hacker News Submit Button | ||
| * @method hackernewssubmit | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @return {string} the result badge | ||
| */ | ||
| function hackernewssubmit ({ homepage }) { | ||
@@ -750,8 +783,9 @@ // Check | ||
| /** | ||
| Facebook Like Button | ||
| @method facebooklike | ||
| @param {String} config.homepage The page url that the badge will be for | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Like Button | ||
| * @method facebooklike | ||
| * @param {Object} opts | ||
| * @param {string} opts.homepage The page url that the badge will be for | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebooklike ({ homepage, facebookApplicationID }) { | ||
@@ -770,8 +804,9 @@ // Prepare | ||
| /** | ||
| Facebook Follow Button | ||
| @method facebookfollow | ||
| @param {String} config.facebookUsername The facebook username to follow | ||
| @param {String} config.facebookApplicationID The facebook application id that the badge is for | ||
| @return {String} the result badge | ||
| */ | ||
| * Facebook Follow Button | ||
| * @method facebookfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.facebookUsername The facebook username to follow | ||
| * @param {string} opts.facebookApplicationID The facebook application id that the badge is for | ||
| * @return {string} the result badge | ||
| */ | ||
| function facebookfollow ({ facebookUsername, facebookApplicationID }) { | ||
@@ -790,7 +825,8 @@ // Prepare | ||
| /** | ||
| Twitter Tweet Button | ||
| @method twittertweet | ||
| @param {String} config.twitterUsername The twitter username to tweet at | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Tweet Button | ||
| * @method twittertweet | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to tweet at | ||
| * @return {string} the result badge | ||
| */ | ||
| function twittertweet ({ twitterUsername }) { | ||
@@ -807,7 +843,8 @@ // Prepare | ||
| /** | ||
| Twitter Follow Button | ||
| @method twitterfollow | ||
| @param {String} config.twitterUsername The twitter username to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Twitter Follow Button | ||
| * @method twitterfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.twitterUsername The twitter username to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function twitterfollow ({ twitterUsername }) { | ||
@@ -824,7 +861,8 @@ // Prepare | ||
| /** | ||
| Github Follow Button | ||
| @method githubfollow | ||
| @param {String} config.githubUsername The github user to follow | ||
| @return {String} the result badge | ||
| */ | ||
| * Github Follow Button | ||
| * @method githubfollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubUsername The github user to follow | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubfollow ({ githubUsername }) { | ||
@@ -841,7 +879,8 @@ // Prepare | ||
| /** | ||
| GitHub Star Button | ||
| @method githubstar | ||
| @param {String} config.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| @return {String} the result badge | ||
| */ | ||
| * GitHub Star Button | ||
| * @method githubstar | ||
| * @param {Object} opts | ||
| * @param {string} opts.githubSlug The github slug that the project lives at (e.g. bevry/badges) | ||
| * @return {string} the result badge | ||
| */ | ||
| function githubstar ({ githubSlug }) { | ||
@@ -862,9 +901,10 @@ // Prepare | ||
| /** | ||
| Quora Follow Button | ||
| @method quorafollow | ||
| @param {String} config.quoraUsername The quora user to follow | ||
| @param {String} [config.quoraRealname] The quora user's name | ||
| @param {String} [config.quoraCode] Some code | ||
| @return {String} the result badge | ||
| */ | ||
| * Quora Follow Button | ||
| * @method quorafollow | ||
| * @param {Object} opts | ||
| * @param {string} opts.quoraUsername The quora user to follow | ||
| * @param {string} [opts.quoraRealname] The quora user's name | ||
| * @param {string} [opts.quoraCode] Some code | ||
| * @return {string} the result badge | ||
| */ | ||
| function quorafollow ({ quoraUsername, quoraRealname, quoraCode }) { | ||
@@ -871,0 +911,0 @@ // Prepare |
Fixed alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.93%
169558
- Lines of code
- increased by4.39%
3801
- Number of lines in readme file
- increased by3.16%
261
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes