Class: BadgeParser

Defined in:

src\components\badges.coffee

Overview

Creates badges based on pkg info

Variables Summary

name =

"BadgeParser"

Instance Method Summary

# (void) run(pkg) Create data for badges @returns [Promise] An array of badges {name: string, img: string, url: string}

Constructor Details

# (void) constructor(options)

Creates a new BadgeParser. By default the following badges will be created: 'npm version', 'build status', 'coverage status', 'dependency status', 'devDependency status', 'Gitter' These can be changed by setting only a subset as options.badges

Parameters:

(options) ( Object ) — An optional set of options

Options Hash: (options):

badges ( Array<String> ) — Badges from badges.json to use
branch ( String ) — The branch to use for the documentation ['master']

Instance Method Details

# (void) run(pkg)

Create data for badges @returns [Promise] An array of badges {name: string, img: string, url: string}

Parameters:

pkg ( Object ) — package.json data