From 4928cb4ae115b19e0dcd76427b53381aa9e1ebc5 Mon Sep 17 00:00:00 2001 From: chris48s Date: Tue, 24 May 2022 19:22:33 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20badges/s?= =?UTF-8?q?hields@708dfb5f5fa95b7e865eb545228942f5394103ea=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- badge-maker_lib_index.js.html | 4 +- badge-maker_lib_xml.js.html | 4 +- core_base-service_base-graphql.js.html | 4 +- core_base-service_base-json.js.html | 4 +- core_base-service_base-svg-scraping.js.html | 4 +- core_base-service_base-xml.js.html | 4 +- core_base-service_base-yaml.js.html | 4 +- core_base-service_base.js.html | 4 +- core_base-service_errors.js.html | 4 +- core_base-service_graphql.js.html | 4 +- core_base-service_resource-cache.js.html | 4 +- core_server_prometheus-metrics.js.html | 4 +- core_server_server.js.html | 4 +- ...-test-runner_create-service-tester.js.html | 4 +- ...ice-test-runner_icedfrisby-shields.js.html | 4 +- ...ice-test-runner_infer-pull-request.js.html | 4 +- core_service-test-runner_runner.js.html | 4 +- ...service-test-runner_service-tester.js.html | 4 +- ...ice-test-runner_services-for-title.js.html | 4 +- core_token-pooling_token-pool.js.html | 4 +- global.html | 4 +- index.html | 4 +- module-badge-maker.html | 4 +- module-badge-maker_lib_xml-ElementList.html | 4 +- module-badge-maker_lib_xml-XmlElement.html | 4 +- module-badge-maker_lib_xml.html | 4 +- ...le-core_base-service_base-BaseService.html | 4 +- ...rvice_base-graphql-BaseGraphqlService.html | 4 +- module-core_base-service_base-graphql.html | 4 +- ...ase-service_base-json-BaseJsonService.html | 4 +- module-core_base-service_base-json.html | 4 +- ...e-svg-scraping-BaseSvgScrapingService.html | 4 +- ...e-core_base-service_base-svg-scraping.html | 4 +- ..._base-service_base-xml-BaseXmlService.html | 4 +- module-core_base-service_base-xml.html | 4 +- ...ase-service_base-yaml-BaseYamlService.html | 4 +- module-core_base-service_base-yaml.html | 4 +- module-core_base-service_base.html | 4 +- ...e-core_base-service_errors-Deprecated.html | 4 +- ...e-service_errors-ImproperlyConfigured.html | 4 +- ...core_base-service_errors-Inaccessible.html | 4 +- ..._base-service_errors-InvalidParameter.html | 4 +- ...e_base-service_errors-InvalidResponse.html | 4 +- module-core_base-service_errors-NotFound.html | 4 +- ...se-service_errors-ShieldsRuntimeError.html | 4 +- module-core_base-service_errors.html | 4 +- module-core_base-service_graphql.html | 4 +- module-core_base-service_resource-cache.html | 4 +- module-core_server_server-Server.html | 4 +- module-core_server_server.html | 4 +- ...ice-test-runner_create-service-tester.html | 4 +- ...ervice-test-runner_icedfrisby-shields.html | 4 +- ...ervice-test-runner_infer-pull-request.html | 4 +- ...ore_service-test-runner_runner-Runner.html | 4 +- module-core_service-test-runner_runner.html | 4 +- ...t-runner_service-tester-ServiceTester.html | 4 +- ...re_service-test-runner_service-tester.html | 4 +- ...ervice-test-runner_services-for-title.html | 4 +- ...e-core_token-pooling_token-pool-Token.html | 4 +- ...re_token-pooling_token-pool-TokenPool.html | 4 +- module-core_token-pooling_token-pool.html | 4 +- module-services_build-status.html | 88 +- module-services_color-formatters.html | 1577 +++++++++++++++++ module-services_downloads.html | 4 +- module-services_dynamic_json-path.html | 4 +- ...ervices_steam_steam-base-BaseSteamAPI.html | 4 +- module-services_steam_steam-base.html | 4 +- services_build-status.js.html | 6 +- services_color-formatters.js.html | 249 +++ services_downloads.js.html | 4 +- services_dynamic_json-path.js.html | 4 +- services_packagist_packagist-base.js.html | 4 +- services_steam_steam-base.js.html | 4 +- services_test-validators.js.html | 4 +- tutorial-TUTORIAL.html | 4 +- tutorial-adding-new-config-values.html | 4 +- tutorial-badge-urls.html | 4 +- tutorial-code-walkthrough.html | 4 +- tutorial-deprecating-badges.html | 4 +- tutorial-input-validation.html | 4 +- tutorial-json-format.html | 4 +- tutorial-logos.html | 4 +- tutorial-performance-testing.html | 4 +- tutorial-production-hosting.html | 4 +- tutorial-releases.html | 4 +- tutorial-self-hosting.html | 4 +- tutorial-server-secrets.html | 4 +- tutorial-service-tests.html | 4 +- 88 files changed, 2082 insertions(+), 174 deletions(-) create mode 100644 module-services_color-formatters.html create mode 100644 services_color-formatters.js.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index abf248ac4b..718ab33eff 100644 --- a/badge-maker_lib_index.js.html +++ b/badge-maker_lib_index.js.html @@ -117,13 +117,13 @@ module.exports = {
diff --git a/badge-maker_lib_xml.js.html b/badge-maker_lib_xml.js.html index c95a808ea8..ba20c461cf 100644 --- a/badge-maker_lib_xml.js.html +++ b/badge-maker_lib_xml.js.html @@ -132,13 +132,13 @@ module.exports = { escapeXml, stripXmlWhitespace, XmlElement, ElementList }
diff --git a/core_base-service_base-graphql.js.html b/core_base-service_base-graphql.js.html index c961cfb156..5093cdb497 100644 --- a/core_base-service_base-graphql.js.html +++ b/core_base-service_base-graphql.js.html @@ -130,13 +130,13 @@ export default BaseGraphqlService
diff --git a/core_base-service_base-json.js.html b/core_base-service_base-json.js.html index 385fe4521d..36e301b7ea 100644 --- a/core_base-service_base-json.js.html +++ b/core_base-service_base-json.js.html @@ -91,13 +91,13 @@ export default BaseJsonService
diff --git a/core_base-service_base-svg-scraping.js.html b/core_base-service_base-svg-scraping.js.html index 33b1648d50..dc5b8068ce 100644 --- a/core_base-service_base-svg-scraping.js.html +++ b/core_base-service_base-svg-scraping.js.html @@ -127,13 +127,13 @@ export default BaseSvgScrapingService
diff --git a/core_base-service_base-xml.js.html b/core_base-service_base-xml.js.html index 6a56adb21d..49bdb3a813 100644 --- a/core_base-service_base-xml.js.html +++ b/core_base-service_base-xml.js.html @@ -106,13 +106,13 @@ export default BaseXmlService
diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index 78b12bd983..a537576ad9 100644 --- a/core_base-service_base-yaml.js.html +++ b/core_base-service_base-yaml.js.html @@ -109,13 +109,13 @@ export default BaseYamlService
diff --git a/core_base-service_base.js.html b/core_base-service_base.js.html index 88f151c3cd..53c0e7d97f 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -613,13 +613,13 @@ export default BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index 92de65897d..97c73ca184 100644 --- a/core_base-service_errors.js.html +++ b/core_base-service_errors.js.html @@ -255,13 +255,13 @@ export {
diff --git a/core_base-service_graphql.js.html b/core_base-service_graphql.js.html index 7fe62a975e..5ad4ff055d 100644 --- a/core_base-service_graphql.js.html +++ b/core_base-service_graphql.js.html @@ -87,13 +87,13 @@ export { mergeQueries }
diff --git a/core_base-service_resource-cache.js.html b/core_base-service_resource-cache.js.html index 3dda35b674..03e7ed383a 100644 --- a/core_base-service_resource-cache.js.html +++ b/core_base-service_resource-cache.js.html @@ -103,13 +103,13 @@ export { getCachedResource, clearResourceCache }
diff --git a/core_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index 3ae6cc38e3..9ba83a37ee 100644 --- a/core_server_prometheus-metrics.js.html +++ b/core_server_prometheus-metrics.js.html @@ -121,13 +121,13 @@ export default class PrometheusMetrics {
diff --git a/core_server_server.js.html b/core_server_server.js.html index 70820c737e..a364005de3 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -627,13 +627,13 @@ export default Server
diff --git a/core_service-test-runner_create-service-tester.js.html b/core_service-test-runner_create-service-tester.js.html index 2a05f54aa1..70a82faf1d 100644 --- a/core_service-test-runner_create-service-tester.js.html +++ b/core_service-test-runner_create-service-tester.js.html @@ -68,13 +68,13 @@ export default createServiceTester
diff --git a/core_service-test-runner_icedfrisby-shields.js.html b/core_service-test-runner_icedfrisby-shields.js.html index a781c3a064..d1a8e4d66b 100644 --- a/core_service-test-runner_icedfrisby-shields.js.html +++ b/core_service-test-runner_icedfrisby-shields.js.html @@ -140,13 +140,13 @@ export default factory
diff --git a/core_service-test-runner_infer-pull-request.js.html b/core_service-test-runner_infer-pull-request.js.html index 18376faf7e..a05356f057 100644 --- a/core_service-test-runner_infer-pull-request.js.html +++ b/core_service-test-runner_infer-pull-request.js.html @@ -136,13 +136,13 @@ export { parseGithubPullRequestUrl, parseGithubRepoSlug, inferPullRequest }
diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index c647c3cf22..52514459ec 100644 --- a/core_service-test-runner_runner.js.html +++ b/core_service-test-runner_runner.js.html @@ -112,13 +112,13 @@ export default Runner
diff --git a/core_service-test-runner_service-tester.js.html b/core_service-test-runner_service-tester.js.html index 272c57d31d..ca838f0ce1 100644 --- a/core_service-test-runner_service-tester.js.html +++ b/core_service-test-runner_service-tester.js.html @@ -178,13 +178,13 @@ export default ServiceTester
diff --git a/core_service-test-runner_services-for-title.js.html b/core_service-test-runner_services-for-title.js.html index 09e9267539..3bae803a99 100644 --- a/core_service-test-runner_services-for-title.js.html +++ b/core_service-test-runner_services-for-title.js.html @@ -69,13 +69,13 @@ export default servicesForTitle
diff --git a/core_token-pooling_token-pool.js.html b/core_token-pooling_token-pool.js.html index f02d45d4d9..db3e64e4a5 100644 --- a/core_token-pooling_token-pool.js.html +++ b/core_token-pooling_token-pool.js.html @@ -373,13 +373,13 @@ export { sanitizeToken, Token, TokenPool }
diff --git a/global.html b/global.html index 5de01d647e..f258415eb3 100644 --- a/global.html +++ b/global.html @@ -678,13 +678,13 @@
diff --git a/index.html b/index.html index cd913bd744..b064a00a98 100644 --- a/index.html +++ b/index.html @@ -217,13 +217,13 @@ under their terms and license.


diff --git a/module-badge-maker.html b/module-badge-maker.html index d08e78dbff..62fd7d284b 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -381,13 +381,13 @@
diff --git a/module-badge-maker_lib_xml-ElementList.html b/module-badge-maker_lib_xml-ElementList.html index ed771dbd3c..b67647f9da 100644 --- a/module-badge-maker_lib_xml-ElementList.html +++ b/module-badge-maker_lib_xml-ElementList.html @@ -157,13 +157,13 @@ like an XmlElement but renders multiple XML tags (not wrapped in a ).


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index 125c23675d..c819b1e221 100644 --- a/module-badge-maker_lib_xml-XmlElement.html +++ b/module-badge-maker_lib_xml-XmlElement.html @@ -468,13 +468,13 @@ element will be rendered as a self-closing element.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index ffa5395ae4..ae1380daae 100644 --- a/module-badge-maker_lib_xml.html +++ b/module-badge-maker_lib_xml.html @@ -80,13 +80,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 244e851af2..a7b35bf45c 100644 --- a/module-core_base-service_base-BaseService.html +++ b/module-core_base-service_base-BaseService.html @@ -739,13 +739,13 @@ defined in this.route.pattern or this.route.capture


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql-BaseGraphqlService.html b/module-core_base-service_base-graphql-BaseGraphqlService.html index af4a59c0e4..f5eb040fc3 100644 --- a/module-core_base-service_base-graphql-BaseGraphqlService.html +++ b/module-core_base-service_base-graphql-BaseGraphqlService.html @@ -823,13 +823,13 @@ an InvalidResponse.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index 0d7ef2c250..fe95b5e633 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json-BaseJsonService.html b/module-core_base-service_base-json-BaseJsonService.html index 19404d27f2..7d16b47df0 100644 --- a/module-core_base-service_base-json-BaseJsonService.html +++ b/module-core_base-service_base-json-BaseJsonService.html @@ -668,13 +668,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 506619efaf..996d1af88d 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html index f5a95833f4..ddbeaaa240 100644 --- a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html +++ b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html @@ -759,13 +759,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-svg-scraping.html b/module-core_base-service_base-svg-scraping.html index 3528448c36..1fee074ad0 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml-BaseXmlService.html b/module-core_base-service_base-xml-BaseXmlService.html index 19cc9af73f..d46d1e6826 100644 --- a/module-core_base-service_base-xml-BaseXmlService.html +++ b/module-core_base-service_base-xml-BaseXmlService.html @@ -551,13 +551,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 16f52f8555..e2a34035a7 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml-BaseYamlService.html b/module-core_base-service_base-yaml-BaseYamlService.html index 245e32e6e4..5d7a50bc86 100644 --- a/module-core_base-service_base-yaml-BaseYamlService.html +++ b/module-core_base-service_base-yaml-BaseYamlService.html @@ -548,13 +548,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index 91f34d6083..298613b7d6 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index c8add4bd14..146752a52b 100644 --- a/module-core_base-service_base.html +++ b/module-core_base-service_base.html @@ -1160,13 +1160,13 @@ when the parameter is absent. (Note that in,
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index 8f84070db6..86005b3b8b 100644 --- a/module-core_base-service_errors-Deprecated.html +++ b/module-core_base-service_errors-Deprecated.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index 5d86ab551e..b72565d59e 100644 --- a/module-core_base-service_errors-ImproperlyConfigured.html +++ b/module-core_base-service_errors-ImproperlyConfigured.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index a4bd94ae76..0c26047b9e 100644 --- a/module-core_base-service_errors-Inaccessible.html +++ b/module-core_base-service_errors-Inaccessible.html @@ -206,13 +206,13 @@ or to wrap a 5XX response


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 2443dd7a04..002695ede5 100644 --- a/module-core_base-service_errors-InvalidParameter.html +++ b/module-core_base-service_errors-InvalidParameter.html @@ -206,13 +206,13 @@ is invalid or unexpected


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index e9d9ad607a..436358c4d7 100644 --- a/module-core_base-service_errors-InvalidResponse.html +++ b/module-core_base-service_errors-InvalidResponse.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index b2d5a3b4b5..f5a6de6abf 100644 --- a/module-core_base-service_errors-NotFound.html +++ b/module-core_base-service_errors-NotFound.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 0fc28fe054..4e1821035a 100644 --- a/module-core_base-service_errors-ShieldsRuntimeError.html +++ b/module-core_base-service_errors-ShieldsRuntimeError.html @@ -378,13 +378,13 @@ should override this method.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 6d53155d86..c6ef652f54 100644 --- a/module-core_base-service_errors.html +++ b/module-core_base-service_errors.html @@ -348,13 +348,13 @@ badge when we catch and render the exception (Optional)


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 7bac7da789..2a1828693b 100644 --- a/module-core_base-service_graphql.html +++ b/module-core_base-service_graphql.html @@ -248,13 +248,13 @@ but can't use that due to incorrect packaging.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_resource-cache.html b/module-core_base-service_resource-cache.html index d3f34cef56..6b69f3f180 100644 --- a/module-core_base-service_resource-cache.html +++ b/module-core_base-service_resource-cache.html @@ -489,13 +489,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index 01f09377da..00c63a4393 100644 --- a/module-core_server_server-Server.html +++ b/module-core_server_server-Server.html @@ -675,13 +675,13 @@ Start listening for requests on this.baseUrl()


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server.html b/module-core_server_server.html index 2c7ff62cc6..6fc210d8e1 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_create-service-tester.html b/module-core_service-test-runner_create-service-tester.html index 7761d79553..81d36927fe 100644 --- a/module-core_service-test-runner_create-service-tester.html +++ b/module-core_service-test-runner_create-service-tester.html @@ -188,13 +188,13 @@ service.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_icedfrisby-shields.html b/module-core_service-test-runner_icedfrisby-shields.html index 9afd1b9a16..9d24e5e944 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -244,13 +244,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_infer-pull-request.html b/module-core_service-test-runner_infer-pull-request.html index 8393ed6b99..1bb77f19ce 100644 --- a/module-core_service-test-runner_infer-pull-request.html +++ b/module-core_service-test-runner_infer-pull-request.html @@ -464,13 +464,13 @@ of a pull request from the environment variables.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner-Runner.html b/module-core_service-test-runner_runner-Runner.html index fd9b3c17bc..549dd90c2d 100644 --- a/module-core_service-test-runner_runner-Runner.html +++ b/module-core_service-test-runner_runner-Runner.html @@ -562,13 +562,13 @@ overridden on instances.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index f17db84512..8a7ccc1bdc 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_service-tester-ServiceTester.html b/module-core_service-test-runner_service-tester-ServiceTester.html index 36e4695e67..9634869626 100644 --- a/module-core_service-test-runner_service-tester-ServiceTester.html +++ b/module-core_service-test-runner_service-tester-ServiceTester.html @@ -1120,13 +1120,13 @@ the CLI, or directly on the tester.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_service-tester.html b/module-core_service-test-runner_service-tester.html index 3e18d69d80..8dc81e37a7 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_services-for-title.html b/module-core_service-test-runner_services-for-title.html index 2db038b358..68a6a8b277 100644 --- a/module-core_service-test-runner_services-for-title.html +++ b/module-core_service-test-runner_services-for-title.html @@ -236,13 +236,13 @@ as an array of strings.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool-Token.html b/module-core_token-pooling_token-pool-Token.html index b60dbb658d..be1dfea9e0 100644 --- a/module-core_token-pooling_token-pool-Token.html +++ b/module-core_token-pooling_token-pool-Token.html @@ -709,13 +709,13 @@ stable ordering for a valid priority queue.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool-TokenPool.html b/module-core_token-pooling_token-pool-TokenPool.html index a52a4e9498..5424abaee8 100644 --- a/module-core_token-pooling_token-pool-TokenPool.html +++ b/module-core_token-pooling_token-pool-TokenPool.html @@ -893,13 +893,13 @@ indicate it should not be reused.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index d0062a8291..77fa5537fd 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -243,13 +243,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_build-status.html b/module-services_build-status.html index ede3563b99..0533c07c66 100644 --- a/module-services_build-status.html +++ b/module-services_build-status.html @@ -29,6 +29,8 @@
+ +
@@ -36,6 +38,84 @@
+

Common functions and schemas for tasks related to build status.

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + @@ -113,7 +193,7 @@ Checks if the build status is present in the list of allowed build status.

Source:
@@ -335,7 +415,7 @@ Determines the message and color of the badge according to the build status.

Source:
@@ -403,13 +483,13 @@ Determines the message and color of the badge according to the build status.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_color-formatters.html b/module-services_color-formatters.html new file mode 100644 index 0000000000..37142c8b82 --- /dev/null +++ b/module-services_color-formatters.html @@ -0,0 +1,1577 @@ + + + + + JSDoc: Module: services/color-formatters + + + + + + + + + + +
+ +

Module: services/color-formatters

+ + + + + + +
+ +
+ + + + + +
+ +
+
+ + +

Commonly-used functions for determining the colour to use for a badge, +including colours based off download count, version number, etc.

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + +

Methods

+ + + + + + + +

(inner) age(date) → {string}

+ + + + + + +
+

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.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
date + + +string + + + +

Date string

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

(inner) colorScale(steps, colors, reversed) → {function}

+ + + + + + +
+

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:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
steps + + +Array.<number> + + + +

Steps array

colors + + +Array.<string> + + + +

Colors array. If provided, should be of length steps.length + 1

reversed + + +boolean + + + +

If true then the colors array will be considered in reverse order

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Function that finds the step index by comparing value +with steps array and returns color from colors array for the corresponding step index

+
+ + + +
+
+ Type +
+
+ +function + + +
+
+ + + + + + + + + + + + + +

(inner) coveragePercentage(percentage) → {string}

+ + + + + + +
+

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:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
percentage + + +number + + + +

Percentage value

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

(inner) downloadCount(downloads) → {string}

+ + + + + + +
+

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:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
downloads + + +number + + + +

Download count

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

(inner) floorCount(value, yellow, yellowgreen, green) → {string}

+ + + + + + +
+

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:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
value + + +number + + + +

Current value

yellow + + +number + + + +

Yellow color threshold, should be greater than 0

yellowgreen + + +number + + + +

Yellowgreen color threshold, should be greater than yellow

green + + +number + + + +

Green color threshold, should be greater than yellowgreen

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

(inner) letterScore(score) → {string}

+ + + + + + +
+

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:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
score + + +string + + + +

Score value

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

(inner) pep440VersionColor(version) → {string}

+ + + + + + +
+

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

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
version + + +string +| + +number + + + +

Version used for determining badge color

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +

(inner) version(version) → {string}

+ + + + + + +
+

Determines the color used for a badge based on version.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
version + + +string +| + +number + + + +

Version used for determining badge color

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Badge color

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time) +
+ + + + + \ No newline at end of file diff --git a/module-services_downloads.html b/module-services_downloads.html index a9b95dab55..36ed5a4f42 100644 --- a/module-services_downloads.html +++ b/module-services_downloads.html @@ -498,13 +498,13 @@ this value as the prefix for versioned badges, e.g. foobar@v1.23. D
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index fadf6441b5..16486deffa 100644 --- a/module-services_dynamic_json-path.html +++ b/module-services_dynamic_json-path.html @@ -536,13 +536,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index 2d76d0b036..13b9ee5cc9 100644 --- a/module-services_steam_steam-base-BaseSteamAPI.html +++ b/module-services_steam_steam-base-BaseSteamAPI.html @@ -374,13 +374,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index cd027042df..41a95d9651 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/services_build-status.js.html b/services_build-status.js.html index b787ffe828..d4249a71c6 100644 --- a/services_build-status.js.html +++ b/services_build-status.js.html @@ -27,6 +27,8 @@
/**
+ * Common functions and schemas for tasks related to build status.
+ *
  * @module
  */
 
@@ -132,13 +134,13 @@ export { isBuildStatus, renderBuildStatusBadge }
 
 
 
 
 
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/services_color-formatters.js.html b/services_color-formatters.js.html new file mode 100644 index 0000000000..697579b8e2 --- /dev/null +++ b/services_color-formatters.js.html @@ -0,0 +1,249 @@ + + + + + JSDoc: Source: services/color-formatters.js + + + + + + + + + + +
+ +

Source: services/color-formatters.js

+ + + + + + +
+
+
/**
+ * Commonly-used functions for determining the colour to use for a badge,
+ * including colours based off download count, version number, etc.
+ *
+ * @module
+ */
+
+import moment from 'moment'
+import pep440 from '@renovate/pep440'
+
+/**
+ * Determines the color used for a badge based on version.
+ *
+ * @param {string|number} version Version used for determining badge color
+ * @returns {string} Badge color
+ */
+function version(version) {
+  if (typeof version !== 'string' && typeof version !== 'number') {
+    throw new Error(`Can't generate a version color for ${version}`)
+  }
+  version = `${version}`
+  let first = version[0]
+  if (first === 'v') {
+    first = version[1]
+  }
+  if (first === '0' || /alpha|beta|snapshot|dev|pre/i.test(version)) {
+    return 'orange'
+  } else {
+    return 'blue'
+  }
+}
+
+/**
+ * Determines the color used for a badge based on PEP440 versioning.
+ *
+ * @param {string|number} version Version used for determining badge color
+ * @returns {string} Badge color
+ */
+function pep440VersionColor(version) {
+  if (!pep440.valid(version)) {
+    return 'lightgrey'
+  }
+  const parsedVersion = pep440.explain(version)
+  if (parsedVersion.is_prerelease || parsedVersion.public.startsWith('0.')) {
+    return 'orange'
+  }
+  return 'blue'
+}
+
+/**
+ * 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.
+ *
+ * @param {number} value Current value
+ * @param {number} yellow Yellow color threshold, should be greater than 0
+ * @param {number} yellowgreen Yellowgreen color threshold, should be greater than yellow
+ * @param {number} green Green color threshold, should be greater than yellowgreen
+ * @returns {string} Badge color
+ */
+function floorCount(value, yellow, yellowgreen, green) {
+  if (value <= 0) {
+    return 'red'
+  } else if (value < yellow) {
+    return 'yellow'
+  } else if (value < yellowgreen) {
+    return 'yellowgreen'
+  } else if (value < green) {
+    return 'green'
+  } else {
+    return 'brightgreen'
+  }
+}
+
+/**
+ * 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.
+ *
+ * @param {number} downloads Download count
+ * @returns {string} Badge color
+ */
+function downloadCount(downloads) {
+  return floorCount(downloads, 10, 100, 1000)
+}
+
+/**
+ * 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.
+ *
+ * @param {number} percentage Percentage value
+ * @returns {string} Badge color
+ */
+function coveragePercentage(percentage) {
+  return floorCount(percentage, 80, 90, 100)
+}
+
+/**
+ * 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.
+ *
+ * @param {string} score Score value
+ * @returns {string} Badge color
+ */
+function letterScore(score) {
+  if (score === 'A') {
+    return 'brightgreen'
+  } else if (score === 'B') {
+    return 'green'
+  } else if (score === 'C') {
+    return 'yellowgreen'
+  } else if (score === 'D') {
+    return 'yellow'
+  } else if (score === 'E') {
+    return 'orange'
+  } else {
+    return 'red'
+  }
+}
+
+/**
+ * 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.
+ *
+ * @param {number[]} steps Steps array
+ * @param {string[]} colors Colors array. If provided, should be of length steps.length + 1
+ * @param {boolean} reversed If true then the colors array will be considered in reverse order
+ * @returns {function(number): string} Function that finds the step index by comparing value
+ * with steps array and returns color from colors array for the corresponding step index
+ */
+function colorScale(steps, colors, reversed) {
+  if (steps === undefined) {
+    throw Error('When invoking colorScale, steps should be provided.')
+  }
+
+  const defaultColors = {
+    1: ['red', 'brightgreen'],
+    2: ['red', 'yellow', 'brightgreen'],
+    3: ['red', 'yellow', 'green', 'brightgreen'],
+    4: ['red', 'yellow', 'yellowgreen', 'green', 'brightgreen'],
+    5: ['red', 'orange', 'yellow', 'yellowgreen', 'green', 'brightgreen'],
+  }
+
+  if (typeof colors === 'undefined') {
+    if (steps.length in defaultColors) {
+      colors = defaultColors[steps.length]
+    } else {
+      throw Error(`No default colors for ${steps.length} steps.`)
+    }
+  }
+
+  if (steps.length !== colors.length - 1) {
+    throw Error(
+      'When colors are provided, there should be n + 1 colors for n steps.'
+    )
+  }
+
+  if (reversed) {
+    colors = Array.from(colors).reverse()
+  }
+
+  return value => {
+    const stepIndex = steps.findIndex(step => value < step)
+
+    // For the final step, stepIndex is -1, so in all cases this expression
+    // works swimmingly.
+    return colors.slice(stepIndex)[0]
+  }
+}
+
+/**
+ * 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.
+ *
+ * @param {string} date Date string
+ * @returns {string} Badge color
+ */
+function age(date) {
+  const colorByAge = colorScale([7, 30, 180, 365, 730], undefined, true)
+  const daysElapsed = moment().diff(moment(date), 'days')
+  return colorByAge(daysElapsed)
+}
+
+export {
+  version,
+  pep440VersionColor,
+  downloadCount,
+  coveragePercentage,
+  floorCount,
+  letterScore,
+  colorScale,
+  age,
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time) +
+ + + + + diff --git a/services_downloads.js.html b/services_downloads.js.html index a39b35c4a3..8a2cc10c5f 100644 --- a/services_downloads.js.html +++ b/services_downloads.js.html @@ -95,13 +95,13 @@ export { renderDownloadsBadge }
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index e5291b4abe..1142e6f205 100644 --- a/services_dynamic_json-path.js.html +++ b/services_dynamic_json-path.js.html @@ -114,13 +114,13 @@ export default superclass =>
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index f3442e3500..36829bd249 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -226,13 +226,13 @@ export {
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 1297552990..22e62a061a 100644 --- a/services_steam_steam-base.js.html +++ b/services_steam_steam-base.js.html @@ -92,13 +92,13 @@ export default BaseSteamAPI
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/services_test-validators.js.html b/services_test-validators.js.html index dcc7fd6dba..a2961dca80 100644 --- a/services_test-validators.js.html +++ b/services_test-validators.js.html @@ -223,13 +223,13 @@ export {
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 168dffb9af..070a78e391 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -371,13 +371,13 @@ will review your contribution.
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-adding-new-config-values.html b/tutorial-adding-new-config-values.html index cb789f4daf..91e5f2f865 100644 --- a/tutorial-adding-new-config-values.html +++ b/tutorial-adding-new-config-values.html @@ -54,13 +54,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 32e3ceacad..b1d800cfdf 100644 --- a/tutorial-badge-urls.html +++ b/tutorial-badge-urls.html @@ -71,13 +71,13 @@ badge is for issues, and the parameters are :user/:repo.
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index f21124e9d9..3b80d6d22d 100644 --- a/tutorial-code-walkthrough.html +++ b/tutorial-code-walkthrough.html @@ -234,13 +234,13 @@ result over the HTTPS connection.
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index bdd8ec4f22..4c736aff98 100644 --- a/tutorial-deprecating-badges.html +++ b/tutorial-deprecating-badges.html @@ -136,13 +136,13 @@ t.create('no longer available (previously number of layers)')
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index c054bb5591..1a15982085 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index 3d2ffa58c0..af0e1e2816 100644 --- a/tutorial-json-format.html +++ b/tutorial-json-format.html @@ -54,13 +54,13 @@ if you have any queries regarding the JSON format.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-logos.html b/tutorial-logos.html index 23cc0a5c8c..b597f31cfe 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -90,13 +90,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index ba5c8605e7..2b8f6450d8 100644 --- a/tutorial-performance-testing.html +++ b/tutorial-performance-testing.html @@ -70,13 +70,13 @@ node --prof-process --preprocess -j isolate-00000244AB6ED3B0-11920-v8.log | flam
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index f8b620f847..72f65d1afe 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -229,13 +229,13 @@ via local-shields-io-production.yml (see Home

Modules

Classes

Tutorials

Global

+

Home

Modules

Classes

Tutorials

Global


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-releases.html b/tutorial-releases.html index 8cf63f45b3..f0adcec0c5 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index 8c7016fe22..14c95a5711 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -167,13 +167,13 @@ Set public.requireCloudflare: true.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index 039e2a3823..38649ae453 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -273,13 +273,13 @@ and create an API key for the YouTube Data API v3.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index f1f922d014..da263ddb9e 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -240,13 +240,13 @@ comment there instead.


- Documentation generated by JSDoc 3.6.10 on Mon May 23 2022 20:49:41 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.10 on Tue May 24 2022 19:22:32 GMT+0000 (Coordinated Universal Time)