Class: exports

exports()

Criterion Badge Service

Support and Contact:

  • https://github.com/chmoder/api.criterion.dev

API Documentation:

  • https://app.swaggerhub.com/apis-docs/chmoder/Criterion.dev

Constructor

new exports()

Source:

Methods

createNumRequestCounter(attrs) → {object}

Parameters:
Name Type Description
attrs object

Refer to individual attrs

Properties
Name Type Description
category string

e.g: 'build'
serviceFamily string

e.g: 'npm'
name string

e.g: 'NpmVersion'
Source:
Returns:

{ inc() {} }.

Type
object

getColor(attrs) → {string}

Return color for active, maintenance and archived statuses, which were the three example keywords used in Netflix's open-source meetup. See https://slideshare.net/aspyker/netflix-open-source-meetup-season-4-episode-1 Other keywords are possible, but will appear in grey.

Parameters:
Name Type Description
attrs object

Refer to individual attrs

Properties
Name Type Description
status string

Specifies the current maintenance status
Source:
Returns:

color

Type
string

render(translatedPercent) → {object}

Takes a percentage and maps it to a message and color.

The colors are determined based on how Weblate does it internally. Weblate on GitHub

Parameters:
Name Type Description
translatedPercent *

The percentage of translations translated.
Source:
Returns:

Format for the badge.

Type
object

exports()

This badge displays the license of a component on a Weblate instance.

Constructor

new exports()

Source:

Methods

createNumRequestCounter(attrs) → {object}

Parameters:
Name Type Description
attrs object

Refer to individual attrs

Properties
Name Type Description
category string

e.g: 'build'
serviceFamily string

e.g: 'npm'
name string

e.g: 'NpmVersion'
Source:
Returns:

{ inc() {} }.

Type
object

getColor(attrs) → {string}

Return color for active, maintenance and archived statuses, which were the three example keywords used in Netflix's open-source meetup. See https://slideshare.net/aspyker/netflix-open-source-meetup-season-4-episode-1 Other keywords are possible, but will appear in grey.

Parameters:
Name Type Description
attrs object

Refer to individual attrs

Properties
Name Type Description
status string

Specifies the current maintenance status
Source:
Returns:

color

Type
string

render(translatedPercent) → {object}

Takes a percentage and maps it to a message and color.

The colors are determined based on how Weblate does it internally. Weblate on GitHub

Parameters:
Name Type Description
translatedPercent *

The percentage of translations translated.
Source:
Returns:

Format for the badge.

Type
object

exports()

This badge displays the percentage of strings translated on a project on a Weblate instance.

Constructor

new exports()

Source:

Methods

createNumRequestCounter(attrs) → {object}

Parameters:
Name Type Description
attrs object

Refer to individual attrs

Properties
Name Type Description
category string

e.g: 'build'
serviceFamily string

e.g: 'npm'
name string

e.g: 'NpmVersion'
Source:
Returns:

{ inc() {} }.

Type
object

getColor(attrs) → {string}

Return color for active, maintenance and archived statuses, which were the three example keywords used in Netflix's open-source meetup. See https://slideshare.net/aspyker/netflix-open-source-meetup-season-4-episode-1 Other keywords are possible, but will appear in grey.

Parameters:
Name Type Description
attrs object

Refer to individual attrs

Properties
Name Type Description
status string

Specifies the current maintenance status
Source:
Returns:

color

Type
string

render(translatedPercent) → {object}

Takes a percentage and maps it to a message and color.

The colors are determined based on how Weblate does it internally. Weblate on GitHub

Parameters:
Name Type Description
translatedPercent *

The percentage of translations translated.
Source:
Returns:

Format for the badge.

Type
object