shields-badges-urls

API

shieldsBadgesUrls(serviceName, serviceParams, options?) => URLs

• serviceName and serviceParams
• options?
  • format?: 'svg', 'png', 'json', etc.
  • urlParams?
• URLs: has two properties, image and link. Both are WHATWG URL objects. The package.json browser field is used so that in Node.js the URLs are instances of URL and in a browser build they are instances of URL.
  • image: The URL for the shields.io badge image
  • link: This is service specific. See the example, below.

Example

import shieldsBadgesUrls from 'shields-badges-urls'

const { image, link } = shieldsBadgesUrls('travis', { userRepo: 'foo/bar' })

image.href
// 'https://img.shields.io/travis/foo/bar.svg'
link.href
// 'https://travis-ci.org/foo/bar'