Module: badge-maker

Methods

(inner) makeBadge(format) → {string}

Create a badge

Parameters:
Name Type Description
format object

Object specifying badge data

Properties
Name Type Description
label string

(Optional) Badge label (e.g: 'build')

message string

(Required) Badge message (e.g: 'passing')

labelColor string

(Optional) Label color

color string

(Optional) Message color

style string

(Optional) Visual style (e.g: 'flat')

logoBase64 string

(Optional) Logo data URL

links Array

(Optional) Links array (e.g: ['https://example.com', 'https://example.com'])

idSuffix string

(Optional) Suffix for IDs, e.g. 1, 2, and 3 for three invocations that will be used on the same page.

Source:
See:
Returns:

Badge in SVG format

Type
string