shields.io (master)

# getAllFilesForPullRequest(client, owner, repo, pullNumber)

Returns info about all files changed in a PR (max 3000 results)

Parameters

# getChangedFilesBetweenTags(client, owner, repo, baseTag, headTag)

Get a list of files changed betwen two tags for a github repo

Parameters

# getLargeJsonAtRef(client, owner, repo, path, ref)

Get large (>1MB) JSON file from git repo on at ref as a json object

Parameters

# _makeBadge()

# makeBadge(format, format.label, format.message, format.labelColor, format.color, format.style)

Create a badge

Parameters

# constructor(attrs, attrs.name, attrs.content, attrs.attrs)

Xml Element Constructor

Parameters

# ElementList()

Convenience class. Sometimes it is useful to return an object that behaves like an XmlElement but renders multiple XML tags (not wrapped in a ).

# render()

Render the XML element to a string, applying appropriate escaping

# XmlElement()

Representation of an XML element

# _parseJson(buffer)

Parse data from JSON endpoint

Parameters

# _requestGraphql(attrs, attrs.schema, attrs.url, attrs.query, attrs.variables, attrs.options, attrs.httpErrorMessages, attrs.systemErrors, attrs.logErrors, attrs.transformJson, attrs.transformErrors)

Request data from an upstream GraphQL API, parse it and validate against a schema

Parameters

# BaseGraphqlService()

Services which query a GraphQL endpoint should extend BaseGraphqlService

# printer.js()

# _parseJson(buffer)

Parse data from JSON endpoint

Parameters

# _requestJson(attrs, attrs.schema, attrs.url, attrs.options, attrs.httpErrors, attrs.systemErrors, attrs.logErrors)

Request data from an upstream API serving JSON, parse it and validate against a schema

Parameters

# base.js()

# BaseJsonService()

Services which query a JSON endpoint should extend BaseJsonService

# _requestSvg(attrs, attrs.schema, attrs.valueMatcher, attrs.url, attrs.options, attrs.httpErrors, attrs.systemErrors, attrs.logErrors)

Request data from an endpoint serving SVG, parse a value from it and validate against a schema

Parameters

# BaseSvgScrapingService()

Services which scrape data from another SVG badge should extend BaseSvgScrapingService

# emoji.muan.co()

# valueFromSvgBadge(svg, valueMatcher)

Extract a value from SVG

Parameters

# _requestToml(attrs, attrs.schema, attrs.url, attrs.options, attrs.httpErrors, attrs.systemErrors, attrs.logErrors)

Request data from an upstream API serving TOML, parse it and validate against a schema

Parameters

# BaseTomlService()

Services which query a TOML endpoint should extend BaseTomlService

# _requestXml(attrs, attrs.schema, attrs.url, attrs.options, attrs.httpErrors, attrs.systemErrors, attrs.logErrors, attrs.parserOptions)

Request data from an upstream API serving XML, parse it and validate against a schema

Parameters

# BaseXmlService()

Services which query a XML endpoint should extend BaseXmlService

# emoji.muan.co()

# _requestYaml(attrs, attrs.schema, attrs.url, attrs.options, attrs.httpErrors, attrs.systemErrors, attrs.logErrors, attrs.encoding)

Request data from an upstream API serving YAML, parse it and validate against a schema

Parameters

# BaseYamlService()

Services which query a YAML endpoint should extend BaseYamlService

# BaseService()

Abstract base class which all service classes inherit from. Concrete implementations of BaseService must implement the methods category(), route() and handle(namedParams, queryParams)

# category()

Name of the category to sort this badge into (eg. "build"). Used to sort the badges on the main shields.io website.

# emoji.muan.co()

# eService()

# getEnum(param)

Extract an array of allowed values from this service's route pattern for a given route parameter

Parameters

# handle(namedParams, queryParams)

Asynchronous function to handle requests for this service. Take the route parameters (as defined in the route property), perform a request using this._requestFetcher, and return the badge data.

Parameters

# route()

Route to mount this service on

# constructor(props, message)

Parameters

# constructor(props)

Parameters

# constructor(props)

Parameters

# constructor(props)

Parameters

# constructor(props)

Parameters

# constructor(props)

Parameters

# constructor(props)

Parameters

# defaultPrettyMessage()

Default message for this exception if none is specified. Implementations of ShieldsRuntimeError should implement this method.

# Deprecated()

Throw this error to indicate that a service is deprecated or removed

# ImproperlyConfigured()

Throw this error when required credentials are missing

# Inaccessible()

Throw this if we can't contact an upstream API or to wrap a 5XX response

# InvalidParameter()

Throw this error when a user supplied input or parameter is invalid or unexpected

# InvalidResponse()

Throw this to wrap an invalid or unexpected response from an upstream API

# name()

Name of the class. Implementations of ShieldsRuntimeError should override this method.

# NotFound()

Throw this to wrap a 404 or other 'not found' response from an upstream API

# ShieldsRuntimeError()

Base error class

# mergeQueries(queries)

Utility function to merge two graphql queries together This is basically copied from graphql-query-merge but can't use that due to incorrect packaging.

Parameters

# baseUrl()

Functions for publishing the shields.io URL schema as an OpenAPI Document

# pathParam(param)

Helper function for assembling an OpenAPI path parameter object

Parameters

# pathParams(params)

Helper function for assembling an array of OpenAPI path parameter objects The code const params = pathParams( { name: 'name1', example: 'example1' }, { name: 'name2', example: 'example2' }, ) is equivalent to const params = [ pathParam({ name: 'name1', example: 'example1' }), pathParam({ name: 'name2', example: 'example2' }), ]

Parameters

# queryParam(param)

Helper function for assembling an OpenAPI query parameter object

Parameters

# queryParams(params)

Helper function for assembling an array of OpenAPI query parameter objects The code const params = queryParams( { name: 'name1', example: 'example1' }, { name: 'name2', example: 'example2' }, ) is equivalent to const params = [ queryParam({ name: 'name1', example: 'example1' }), queryParam({ name: 'name2', example: 'example2' }), ]

Parameters

# errors.js()

# getCachedResource(attrs, attrs.url, attrs.ttl, attrs.json, attrs.scraper, attrs.options, attrs.requestFetcher)

Make a HTTP request using an in-memory cache

Parameters

# openApiSchema()

Joi schema describing the subset of OpenAPI paths we use in this application

# createNumRequestCounter(attrs, attrs.category, attrs.serviceFamily, attrs.name)

Parameters

# constructor(config)

Badge Server Constructor

Parameters

# registerErrorHandlers()

Set up Scoutcamp routes for 404/not found responses

# registerRedirects()

Set up a couple of redirects: One for the raster badges. Another to redirect the base URL / (we use this to redirect {@link https://img.shields.io/} to {@link https://shields.io/} )

# registerServices()

Iterate all the service classes defined in /services, load each service and register a Scoutcamp route for each service.

# Server()

The Server is based on the web framework Scoutcamp. It creates an http server, sets up helpers for token persistence and monitoring. Then it loads all the services, injecting dependencies as it asks each one to register its route with Scoutcamp.

# start()

Start the HTTP server: Bootstrap Scoutcamp, Register handlers, Start listening for requests on this.baseUrl()

# stop()

Stop the HTTP server and clean up helpers

# createServiceTester()

Automatically create a ServiceTester. When run from e.g. gem-rank.tester.js, this will create a tester that attaches to the service found in gem-rank.service.js. This can't be used for .service.js files which export more than one service.

# factory(superclass)

Factory which wraps an "icedfrisby-nock" with some additional functionality: - check if a request was intercepted - set expectations on the badge JSON response

Parameters

# beforeEach()

Function to invoke before each test. This is a stub which can be overridden on instances.

# loader.js()

# only(services)

Limit the test run to the specified services.

Parameters

# prepare()

Prepare the runner by loading up all the ServiceTester objects.

# Runner()

Load a collection of ServiceTester objects and register them with Mocha.

# toss()

Register the tests with Mocha.

# beforeEach()

Invoked before each test. This is a stub which can be overridden on instances.

# constructor(attrs, attrs.id, attrs.title, attrs.pathPrefix)

Service Tester Constructor

Parameters

# create(msg)

Create a new test. The hard work is delegated to IcedFrisby. {@link https://github.com/MarkHerhold/IcedFrisby/#show-me-some-code} Note: The caller should not invoke toss() on the Frisby chain, as it's invoked automatically by the tester.

Parameters

# eUrl(attrs, attrs.baseUrl, attrs.skipIntercepted, attrs.retry, attrs.retry.count, attrs.retry.backoff)

Register the tests with Mocha.

Parameters

# only()

Run only this tester. This can be invoked using the --only argument to the CLI, or directly on the tester.

# s(ServiceClass)

Construct a ServiceTester instance for a single service class

Parameters

# ServiceTester()

Encapsulate a suite of tests. Create new tests using create() and register them with Mocha using toss().

# lodash.difference()

# servicesForTitle(title)

Given a pull request title like '[Travis Sonar] Support user token authentication' extract the list of service names in square brackets as an array of strings.

Parameters

# add(id, data, usesRemaining, nextReset)

Add a token with user-provided ID and data.

Parameters

# compareTokens(first, second)

compareTokens

Parameters

# constructor(id, data, usesRemaining, nextReset)

Token Constructor

Parameters

# constructor(batchSize)

TokenPool Constructor

Parameters

# forEach(callback)

Iterate over all valid tokens.

Parameters

# freeze()

Freeze the uses remaining and next reset values. Helpful for keeping stable ordering for a valid priority queue.

# invalidate()

Indicate that the token should no longer be used.

# next()

Obtain the next available token, returning null if no tokens are available. Tokens are initially pulled from a FIFO queue. The first token is used for a batch of requests, then returned to the queue to give those requests the opportunity to complete. The next token is used for the next batch of requests. This strategy allows a token to be used for concurrent requests, not just sequential request, and simplifies token recovery after errored and timed out requests. By the time the original token re-emerges, its requests should have long since completed. Even if a couple them are still running, they can reasonably be ignored. The uses remaining won't be 100% correct, but that's fine, because Shields uses only 75% The process continues until an exhausted token is pulled from the FIFO queue. At that time it's placed in the priority queue based on its scheduled reset time. To ensure the priority queue works as intended, the scheduled reset time is frozen then. After obtaining a token using next(), invoke update() on it to set a new use-remaining count and next-reset time. Invoke invalidate() to indicate it should not be reused.

# sanitizeToken(id)

Compute a one-way hash of the input string.

Parameters

# Token()

Encapsulate a rate-limited token, with a user-provided ID and user-provided data. Each token has a notion of the number of uses remaining until exhausted, and the next reset time, when it can be used again even if it's exhausted.

# TokenPool()

Encapsulate a collection of rate-limited tokens and choose the next available token when one is needed. Designed for the Github API, though may be also useful with other rate- limited APIs.

# unfreeze()

Unfreeze the uses remaining and next reset values.

# update(usesRemaining, nextReset)

Update the uses remaining and next reset time for a token.

Parameters

# isBuildStatus()

Joi schema for validating Build Status. Checks if the build status is present in the list of allowed build status.

# renderBuildStatusBadge(attrs, attrs.label, attrs.status)

Handles rendering concerns of badges that display build status. Determines the message and color of the badge according to the build status.

Parameters

# age(date, reversed)

Determines the color used for a badge according to the age. Age is calculated as days elapsed till current date. The color varies from bright green to red as the age increases or the other way around if reverse is given true.

Parameters

# colorScale(steps, colors, reversed)

Creates a callback function that determines badge color from the colors array. If the colors array is provided then for n steps, there should be n + 1 color. If the colors array is not provided then it is chosen from the default colors array according to the size of the steps array.

Parameters

# coveragePercentage(percentage)

Determines the color used for a badge by comparing percentage and floor values. The color varies from red to bright green as the percentage increases.

Parameters

# downloadCount(downloads)

Determines the color used for a badge by comparing the download count and floor values. The color varies from red to bright green as the download count increases.

Parameters

# floorCount(value, yellow, yellowgreen, green)

Determines the color used for a badge by comparing the value and floor count values. The color can vary from red to bright green depending on the range the value lies in. Decreasing the value will shift the color towards red. Increasing the value will shift the color towards bright green.

Parameters

# letterScore(score)

Determines the color used for a badge by matching score with grade values. The color varies from bright green to red as the score decreases. The score can be one of the following grade value: ['A', 'B', 'C', 'D', 'E']. The color defaults to red if the score does not matches with any of the grade values.

Parameters

# pep440VersionColor(version)

Determines the color used for a badge based on PEP440 versioning.

Parameters

# version(version)

Determines the color used for a badge based on version.

Parameters

# contributorColor(contributorCount)

Determines the color used for a badge based on the contributor count. The color varies from red to bright green as the contributor count increases.

Parameters

# formatters.js()

Common functions and utilities for tasks related to contributor count.

# renderContributorBadge(attrs, attrs.label, attrs.contributorCount)

Handles rendering concerns of badges that display contributor count. Determines the message and color of the badge according to the contributor count.

Parameters

# formatters.js()

# renderDownloadsBadge(attrs, attrs.downloads, attrs.interval, attrs.version, attrs.labelOverride, attrs.colorOverride, attrs.messageSuffixOverride, attrs.versionedLabelPrefix)

Handles rendering concerns of badges that display download counts, with override/customization support

Parameters

# compoundValueSchema()

Joi schema for validating compound value. Checks if the compound value is of type individualValueSchema, array of individualValueSchema or empty array.

# httpErrors()

Map of error codes and their corresponding error messages.

# individualValueSchema()

Joi schema for validating individual value. Checks if the individual value is of type string or number.

# renderDynamicBadge(attrs, attrs.defaultLabel, attrs.tag, attrs.value, attrs.prefix, attrs.suffix)

Handles rendering concerns of dynamic badges. Determines the label of the badge according to the tag and defaultLabel. Determines the message of the badge according to the prefix, suffix and value. Sets the color of the badge to blue.

Parameters

# transformAndValidate(attrs, attrs.data, attrs.key)

Look up the value in the data object by key and validate the value against compoundValueSchema.

Parameters

# fetch(attrs, attrs.schema, attrs.url, attrs.httpErrors)

Request data from an upstream API, transform it to JSON and validate against a schema

Parameters

# s(superclass)

Dynamic service class factory which wraps {@link module:core/base-service/base~BaseService} with support of {@link https://jsonpath.com/|JSONPath}.

Parameters

# endpointSchema()

Joi schema for validating endpoint.

# fetchEndpointData(serviceInstance, attrs, attrs.url, attrs.httpErrors, attrs.validationPrettyErrorMessage, attrs.includeKeys)

Fetches data from the endpoint and validates the data.

Parameters

# validateEndpointData(data, attrs, attrs.prettyErrorMessage, attrs.includeKeys)

Strictly validate the data according to the endpoint schema. This rejects unknown/invalid keys. Optionally it prints those keys in the message to provide detailed feedback.

Parameters

# FreeCodeCampPoints()

This badge displays the total number of points a student has accumulated from completing challenges on freeCodeCamp.

# schema()

Validates that the schema response is what we're expecting. The username pattern should match the requirements in the freeCodeCamp repository.

# t.create()

Opened issue number case

# t.create()

Closed issue number case

# t.create()

All issue number case

# t.create()

Opened pulls number case

# t.create()

Closed pulls number case

# t.create()

All pulls number case

# clock()

# validateAffiliations(value, helpers)

Validates affiliations should contain combination of allowed values in any order.

Parameters

# t.create()

Opened issue number case

# t.create()

Closed issue number case

# t.create()

All issue number case

# t.create()

Opened issue number case

# t.create()

Closed issue number case

# t.create()

All issue number case

# array.js()

Common functions and utilities for tasks related to license badges.

# licenseToColor(licenses)

Maps the license to its corresponding color and priority and sorts the list of mapped licenses by priority.

Parameters

# licenseToColorMap()

Mapping of licenses to their corresponding color and priority.

# renderLicenseBadge(attrs, attrs.license, attrs.licenses, attrs.color)

Handles rendering concerns of license badges. Determines the message of the badge by joining the licenses in a comma-separated format. Sets the badge color to the provided value, if not provided then the color is used from licenseToColorMap.

Parameters

# formatters.js()

Utilities relating to Lua 'rocks' version numbers. This compares version numbers using the algorithm followed by luarocks command-line utility. Some specific things about LuaRocks package versioning: 1. A version string consists of two parts: the package version (version of the package code) and the revision of rockspec file https://github.com/luarocks/luarocks/wiki/Rockspec-format > version (string, mandatory field) - the version of the package, plus a suffix indicating the revision of the rockspec. Example: "2.0.1-1" 2. The package version (the first part of the LuaRocks version, the part before dash) can be anything, SemVer is not mandatory and is not used very often. Non-digit versions are not rare: scm, dev, alpha, etc. 3. scm (or cvs) is used to indicate dev version built from VCS (e.g. "scm-1"). dev version string is also used sometimes, and I don't know what the difference. 4. LuaRocks API does not tell you which version is the “latest”, and the package maintainer cannot mark a specific version as the latest. You should figure out it yourself. https://github.com/luarocks/luarocks/blob/405ee29ba8444d97646f62e72effeaff2bfe3f79/src/luarocks/search.lua#L182 https://github.com/luarocks/luarocks/blob/405ee29ba8444d97646f62e72effeaff2bfe3f79/src/luarocks/core/vers.lua#L83

# getColor(attrs, attrs.status)

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

# getDependencyVersion(attrs, attrs.kind, attrs.wantedDependency, attrs.dependencies, attrs.devDependencies, attrs.peerDependencies, attrs.optionalDependencies)

Determines the dependency version based on the dependency type.

Parameters

# isDependencyMap()

Joi schema for validating dependency map.

# isPackageJsonWithDependencies()

Joi schema for validating package json object. Checks if the object has all the dependency types and the dependency types are valid.

# e(versions, includePrereleases)

Find the object representation of the latest release.

Parameters

# expandPackageVersions(json, packageName)

Extract the array of minified versions of the given packageName, expand them back to their original format then return.

Parameters

# fetchByJsonAPI(attrs, attrs.user, attrs.repo, attrs.schema, attrs.server)

It is highly recommended to use base fetch method! JSON API includes additional information about downloads, dependents count, github info, etc. However, responses from JSON API are cached for twelve hours by packagist servers, so data fetch from this method might be outdated. For more information please refer to https://packagist.org/apidoc#get-package-data.

Parameters

# packagist.org(attrs, attrs.user, attrs.repo, attrs.schema, attrs.server)

Default fetch method. This method utilizes composer metadata API which "... is the preferred way to access the data as it is always up to date, and dumped to static files so it is very efficient on our end." (comment from official documentation). For more information please refer to https://packagist.org/apidoc#get-package-data.

Parameters

# packagist.org(attrs, attrs.user, attrs.repo, attrs.schema, attrs.server)

Fetch dev releases method. This method utilizes composer metadata API which "... is the preferred way to access the data as it is always up to date, and dumped to static files so it is very efficient on our end." (comment from official documentation). For more information please refer to https://packagist.org/apidoc#get-package-data.

Parameters

# asciiVersionCompare(v1, v2)

Return a negative value if v1 < v2, zero if v1 = v2, a positive value otherwise.

Parameters

# compare(v1, v2)

Compares two versions and return an integer based on the result. See https://getcomposer.org/doc/04-schema.md#version and https://github.com/badges/shields/issues/319#issuecomment-74411045

Parameters

# getPhpReleases(githubApiProvider)

Fetches the PHP release versions from cache if exists, else fetch from the source url and save in cache.

Parameters

# got.js()

Utilities relating to PHP version numbers. This compares version numbers using the algorithm followed by Composer (see https://getcomposer.org/doc/04-schema.md#version).

# isStable(version)

Determines if a version is stable or not.

Parameters

# latest(versions)

Determines the latest version from a list of versions.

Parameters

# minorVersion(version)

Checks if a version is valid and returns the minor version.

Parameters

# numberedVersionData(version)

Take a version without the starting v. eg, '1.0.x-beta' Return { numbers: [1,0,something big], modifier: 2, modifierCount: 1 }

Parameters

# toNum(s)

Try to convert to a list of numbers.

Parameters

# versionReduction(versions, phpReleases)

Reduces the list of php versions that intersect with release versions to a version range (for eg. '5.4 - 7.1', '>= 5.5').

Parameters

# getDependencyVersion(attrs, attrs.kind, attrs.wantedDependency, attrs.lockfileData)

Determines the dependency version based on the dependency type.

Parameters

# isDependency()

Joi schema for validating dependency.

# isLockfile()

Joi schema for validating lock file object. Checks if the lock file object has required properties and the properties are valid.

# array.js()

Common functions and utilities for tasks related to route building

# e(attrs, attrs.base)

Creates a RouteBuilder object.

Parameters

# format()

Get the format components separated by '/'

# push(format, capture)

Saves the format and capture values in the RouteBuilder instance.

Parameters

# toObject()

Returns a new object based on RouteBuilder instance containing its base, format and capture properties.

# BaseSteamAPI()

The steam api is based like /{interface}/{method}/v{version}/

# index.js()

# interf()

Steam API Interface

# method()

Steam API Method

# version()

Steam API Version

# fakeJwtToken()

Generate a fake JWT Token valid for 1 hour for use in testing.

# generateFakeConfig(serviceClass, fakeKey, fakeUser, fakeauthorizedOrigins)

Generates a configuration object with a fake key based on the provided class. For use in auth tests where a config with a test key is required.

Parameters

# getBadgeExampleCall(serviceClass)

Retrieves an example set of parameters for invoking a service class using OpenAPI example of that class.

Parameters

# getServiceClassAuthOrigin(serviceClass)

Returns the first auth origin found for a provided service class.

Parameters

# testAuth(serviceClass, authMethod, dummyResponse, options, options.contentType, options.apiHeaderKey, options.bearerHeaderKey, options.queryUserKey, options.queryPassKey, options.jwtLoginEndpoint)

Test authentication of a badge for it's first OpenAPI example using a provided dummyResponse and authentication method.

Parameters

# isMetricWithPattern(nestedRegexp)

Parameters

# addv(version)

Add a starting v to the version unless it doesn't starts with a digit or is a date (yyyy-mm-dd) For example, addv("1.2.3") returns "v1.2.3", but addv("hello") or addv("2021-10-31"), returns "hello" and "2021-10-31" respectively.

Parameters

# currencyFromCode(code)

Converts the ISO 4217 code to the corresponding currency symbol. If the the symbol for the code is not found, then the code itself is returned.

Parameters

# formatDate(d)

Returns a formatted date string without the year based on the value of input date param d.

Parameters

# formatRelativeDate(timestamp)

Returns a relative date from the input timestamp. For example, day after tomorrow's timestamp will return 'in 2 days'.

Parameters

# maybePluralize(singular, countable, plural)

Returns a string that is either the singular or the plural form of a word, depending on the length of the countable parameter.

Parameters

# metric(n)

Given a number (positive or negative), returns a string with appropriate unit in the metric system, SI. Note: numbers beyond the peta- cannot be represented as integers in JS. For example, if you call metric(1000), it will return "1k", which means one kilo or one thousand.

Parameters

# omitv(version)

Remove the starting v in a string if it exists. For example, omitv("v1.2.3") returns "1.2.3", but omitv("hello") returns "hello".

Parameters

# ordinalNumber(n)

Calculates the ordinal number of the given number. For example, if the input is 1, the output is “1ˢᵗ”.

Parameters

# starRating(rating, max)

Creates a string of stars and empty stars based on the rating. The number of stars is determined by the integer part of the rating. An additional star or a three-quarter star or a half star or a quarter star is added based on the decimal part of the rating. The remaining stars are empty stars until the maximum number of stars is reached.

Parameters

# BaseThunderstoreService()

Services which query Thunderstore endpoints should extend BaseThunderstoreService

# fetchPackageMetrics(pkg, pkg.namespace, pkg.packageName)

Fetches package metrics from the Thunderstore API.

Parameters

# handle(pkg, pkg.namespace, pkg.packageName)

Parameters

# handle(pkg, pkg.namespace, pkg.packageName)

Parameters

# handle(pkg, pkg.namespace, pkg.packageName)

Parameters

# anyInteger()

Joi validator that checks if a value is a number, an integer and the value must be present.

# fileSize()

Joi validator for a file size we are going to pass to bytes.parse see https://github.com/visionmedia/bytes.js#bytesparsestringnumber-value-numbernull

# nonNegativeInteger()

Joi validator that checks if a value is a number, an integer, greater than or equal to zero and the value must be present.

# optionalDottedVersionNClausesWithOptionalSuffix()

Joi validator that checks if a value is a string that matches a regular expression. The regular expression matches strings that start with one or more digits, followed by zero or more groups of a dot and one or more digits, followed by an optional suffix that starts with a dash or a plus sign and can contain any characters. This validator can be used to validate properties that can be version strings with an optional suffix or absent. For example, some valid values for this validator are: 1, 1.0, 1.0.0, 1.0.0-beta Some invalid values for this validator are: abc, 1.a, 1.0-, .1

# optionalNonNegativeInteger()

Joi validator that checks if a value is a number, an integer, and greater than or equal to zero.

# optionalUrl()

Joi validator that checks if a value is a URL TODO: This accepts URLs with query strings and fragments, which for some purposes should be rejected.

# relativeUri()

Joi validator that checks if a value is a relative-only URI

# semver()

Joi validator that checks if a value is a valid semantic versioning string and the value must be present.

# semverRange()

Joi validator that checks if a value is a valid semantic versioning range and the value must be present.

# compareDottedVersion(v1, v2)

Compares two strings representing version numbers lexicographically and returns an integer value.

Parameters

# latest(versions, options, options.pre)

Finds the largest version number lexicographically or semantically from an array of strings representing version numbers and returns it as a string. latest() is looser than latestMaybeSemVer() as it will attempt to make sense of anything, falling back to alphabetic sorting. We should ideally prefer latest() over latestMaybeSemVer() when adding version badges.

Parameters

# latestDottedVersion(versions)

Finds the largest version number lexicographically from an array of strings representing version numbers and returns it as a string.

Parameters

# latestMaybeSemVer(versions, pre)

Finds the largest version number lexicographically or semantically from an array of strings representing version numbers and returns it as a string. latestMaybeSemVer() is used for versions that match some kind of dotted version pattern.

Parameters

# listCompare(a, b)

Compares two arrays of numbers lexicographically and returns an integer value.

Parameters

# rangeStart(v)

Returns the start of the range that matches a given version string.

Parameters

# renderVersionBadge(options, options.version, options.tag, options.defaultLabel, options.versionFormatter)

Creates a badge object that displays information about a version number. It should usually be used to output a version badge.

Parameters

# slice(v, releaseType)

Slices the specified number of dotted parts from the given semver version.

Parameters

# WeblateComponentLicense()

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

# render(translatedPercent)

Takes a percentage and maps it to a message and color. The colors are determined based on how Weblate does it internally. {@link https://github.com/WeblateOrg/weblate/blob/main/weblate/trans/widgets.py Weblate on GitHub}

Parameters

# WeblateProjectTranslatedPercentage()

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

# queryParams()

Array of OpenAPI Parameter Objects describing the up_message, down_message, up_color and down_color query params

# queryParamSchema()

Joi schema for validating query params. Checks if the query params object has valid up_message, down_message, up_color and down_color properties.

# renderWebsiteStatus(options, options.isUp, options.upMessage, options.downMessage, options.upColor, options.downColor)

Creates a badge object that displays information about website status.

Parameters

# WikiapiaryInstalls()

This badge displays the total installations of a MediaWiki extensions, skins, etc via Wikiapiary. {@link https://www.mediawiki.org/wiki/Manual:Extensions MediaWiki Extensions Manual}