From de9e630cbea62f4ca40e1bb92749765c3db3d21a Mon Sep 17 00:00:00 2001 From: "github-merge-queue[bot]" Date: Mon, 21 Aug 2023 11:21:50 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20badges/s?= =?UTF-8?q?hields@531d2acf5cf899ce26be459300845e2fef5c4cab=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-toml.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_openapi.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 +- 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 +- ...ase-service_base-toml-BaseTomlService.html | 4 +- module-core_base-service_base-toml.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_openapi.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 +- ...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 | 4 +- module-services_color-formatters.html | 4 +- module-services_contributor-count.html | 4 +- module-services_downloads.html | 4 +- module-services_dynamic-common.html | 4 +- module-services_dynamic_json-path.html | 4 +- module-services_endpoint-common.html | 4 +- module-services_licenses.html | 4 +- module-services_package-json-helpers.html | 4 +- module-services_php-version.html | 4 +- module-services_pipenv-helpers.html | 4 +- module-services_route-builder.html | 4 +- ...ervices_steam_steam-base-BaseSteamAPI.html | 4 +- module-services_steam_steam-base.html | 4 +- module-services_text-formatters.html | 4 +- module-services_validators.html | 4 +- module-services_version.html | 4 +- module-services_website-status.html | 669 ++++++++++++++++++ services_build-status.js.html | 4 +- services_color-formatters.js.html | 4 +- services_contributor-count.js.html | 4 +- services_downloads.js.html | 4 +- services_dynamic-common.js.html | 4 +- services_dynamic_json-path.js.html | 4 +- services_endpoint-common.js.html | 4 +- services_licenses.js.html | 4 +- services_package-json-helpers.js.html | 4 +- services_packagist_packagist-base.js.html | 4 +- services_php-version.js.html | 4 +- services_pipenv-helpers.js.html | 4 +- services_route-builder.js.html | 4 +- services_steam_steam-base.js.html | 4 +- services_test-validators.js.html | 4 +- services_text-formatters.js.html | 4 +- services_validators.js.html | 4 +- services_version.js.html | 4 +- services_website-status.js.html | 114 +++ tutorial-TUTORIAL.html | 4 +- tutorial-adding-new-config-values.html | 4 +- tutorial-authentication.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 +- tutorial-static-badges.html | 4 +- 117 files changed, 1013 insertions(+), 230 deletions(-) create mode 100644 module-services_website-status.html create mode 100644 services_website-status.js.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index 9b5a1f4f0a..0bf257b46f 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 dd8e56c5b3..6c8756e6c5 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 05925ef987..32f82b21ee 100644 --- a/core_base-service_base-graphql.js.html +++ b/core_base-service_base-graphql.js.html @@ -138,13 +138,13 @@ export default BaseGraphqlService
diff --git a/core_base-service_base-json.js.html b/core_base-service_base-json.js.html index 2e19b41453..42fd7ab916 100644 --- a/core_base-service_base-json.js.html +++ b/core_base-service_base-json.js.html @@ -104,13 +104,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 d134737b27..621775d41d 100644 --- a/core_base-service_base-svg-scraping.js.html +++ b/core_base-service_base-svg-scraping.js.html @@ -135,13 +135,13 @@ export default BaseSvgScrapingService
diff --git a/core_base-service_base-toml.js.html b/core_base-service_base-toml.js.html index 850ef4fbd3..6ffc599396 100644 --- a/core_base-service_base-toml.js.html +++ b/core_base-service_base-toml.js.html @@ -118,13 +118,13 @@ export default BaseTomlService
diff --git a/core_base-service_base-xml.js.html b/core_base-service_base-xml.js.html index fa3e13290b..549654b42f 100644 --- a/core_base-service_base-xml.js.html +++ b/core_base-service_base-xml.js.html @@ -114,13 +114,13 @@ export default BaseXmlService
diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index ef97b567b7..91cf8bfc82 100644 --- a/core_base-service_base-yaml.js.html +++ b/core_base-service_base-yaml.js.html @@ -117,13 +117,13 @@ export default BaseYamlService
diff --git a/core_base-service_base.js.html b/core_base-service_base.js.html index 7a7d6c28b6..835f3692fa 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -652,13 +652,13 @@ export default BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index 55f689cd4c..1a3eab976f 100644 --- a/core_base-service_errors.js.html +++ b/core_base-service_errors.js.html @@ -259,13 +259,13 @@ export {
diff --git a/core_base-service_graphql.js.html b/core_base-service_graphql.js.html index a62ccb3239..628c9617f6 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_openapi.js.html b/core_base-service_openapi.js.html index 0c7da0863d..0654e32b1c 100644 --- a/core_base-service_openapi.js.html +++ b/core_base-service_openapi.js.html @@ -505,13 +505,13 @@ export { category2openapi, pathParam, pathParams, queryParam, queryParams }
diff --git a/core_base-service_resource-cache.js.html b/core_base-service_resource-cache.js.html index f0370faebf..690bf972ca 100644 --- a/core_base-service_resource-cache.js.html +++ b/core_base-service_resource-cache.js.html @@ -105,13 +105,13 @@ export { getCachedResource, clearResourceCache }
diff --git a/core_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index 471b493bfb..7e6f8a274b 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 0d574f3374..7dce47e1ff 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -638,13 +638,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 a62e81f56a..700792f2e8 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 920b8b020f..269ba675be 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_runner.js.html b/core_service-test-runner_runner.js.html index feccd5516c..fbdec97649 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 5dd1198170..2fac37261f 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 2e71d22ed9..268a27cfa4 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 f94062aad6..55ebdf3e3f 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 e79dc23e09..11a813b306 100644 --- a/global.html +++ b/global.html @@ -678,13 +678,13 @@
diff --git a/index.html b/index.html index 95c6dfacb9..9a09903f4e 100644 --- a/index.html +++ b/index.html @@ -214,13 +214,13 @@ under their terms and license.


diff --git a/module-badge-maker.html b/module-badge-maker.html index 2bd558bac3..316fd8a3fb 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -423,13 +423,13 @@
diff --git a/module-badge-maker_lib_xml-ElementList.html b/module-badge-maker_lib_xml-ElementList.html index 8968ee4994..f34ec0ee4b 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index 281b9e401a..494e99f236 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index 1b01613268..57c7043a4b 100644 --- a/module-badge-maker_lib_xml.html +++ b/module-badge-maker_lib_xml.html @@ -122,13 +122,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 79cba75269..2e19478f47 100644 --- a/module-core_base-service_base-BaseService.html +++ b/module-core_base-service_base-BaseService.html @@ -809,13 +809,13 @@ defined in this.route.pattern or this.route.capture


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 b9b9527e0f..562cba3c9e 100644 --- a/module-core_base-service_base-graphql-BaseGraphqlService.html +++ b/module-core_base-service_base-graphql-BaseGraphqlService.html @@ -867,13 +867,13 @@ an InvalidResponse.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index 0affb65f1d..584a0c18db 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 56c0092408..514f8bc0ac 100644 --- a/module-core_base-service_base-json-BaseJsonService.html +++ b/module-core_base-service_base-json-BaseJsonService.html @@ -712,13 +712,13 @@ and module:cor
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 2580a6f2ef..fcbe4d06c0 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 2a27804d31..d33e4612e7 100644 --- a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html +++ b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html @@ -803,13 +803,13 @@ and module:cor
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 207d5ce233..7112b8e497 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-toml-BaseTomlService.html b/module-core_base-service_base-toml-BaseTomlService.html index d681b18108..ffae2554de 100644 --- a/module-core_base-service_base-toml-BaseTomlService.html +++ b/module-core_base-service_base-toml-BaseTomlService.html @@ -553,13 +553,13 @@ and module:cor
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-toml.html b/module-core_base-service_base-toml.html index f5c383e573..38b0ca0183 100644 --- a/module-core_base-service_base-toml.html +++ b/module-core_base-service_base-toml.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 ce70dbe4a2..3fc17b9eb7 100644 --- a/module-core_base-service_base-xml-BaseXmlService.html +++ b/module-core_base-service_base-xml-BaseXmlService.html @@ -595,13 +595,13 @@ and module:cor
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 43bbb5330a..1f2dbbc96d 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 4b36d2d28f..f1f9ac0233 100644 --- a/module-core_base-service_base-yaml-BaseYamlService.html +++ b/module-core_base-service_base-yaml-BaseYamlService.html @@ -592,13 +592,13 @@ and module:cor
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index 51622577a6..bae6e1d91d 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index 14dc1614b1..eba631c92e 100644 --- a/module-core_base-service_base.html +++ b/module-core_base-service_base.html @@ -1202,13 +1202,13 @@ when the parameter is absent. (Note that in,
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index b3afb72188..18473fe492 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index 279b0e9835..40302cec39 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index e292fec47d..1bc56cc175 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 43efa77803..e183cfdbe4 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index 5eb5e3b764..eaf039b143 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index fb2acb1c3f..2f881a3643 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 159bd1cf26..5ee9f404fa 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 2b8f988946..8cb09f50df 100644 --- a/module-core_base-service_errors.html +++ b/module-core_base-service_errors.html @@ -337,13 +337,13 @@ for. Defaults to the cacheLength of the service class throwing the error
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 9a4053f354..b88aaacf4e 100644 --- a/module-core_base-service_graphql.html +++ b/module-core_base-service_graphql.html @@ -290,13 +290,13 @@ but can't use that due to incorrect packaging.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_openapi.html b/module-core_base-service_openapi.html index 8f03bba16f..70a9364fbc 100644 --- a/module-core_base-service_openapi.html +++ b/module-core_base-service_openapi.html @@ -1627,13 +1627,13 @@ Query params are usually strings. (Optional)


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_resource-cache.html b/module-core_base-service_resource-cache.html index 2f779e0ca9..1fbc0ed9ab 100644 --- a/module-core_base-service_resource-cache.html +++ b/module-core_base-service_resource-cache.html @@ -562,13 +562,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index 1cbbb64ce3..4079d3d550 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server.html b/module-core_server_server.html index 391557563d..d1f07860df 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 f9b510c739..5ffeb01def 100644 --- a/module-core_service-test-runner_create-service-tester.html +++ b/module-core_service-test-runner_create-service-tester.html @@ -230,13 +230,13 @@ service.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 c81f45e51b..fab45625c3 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -286,13 +286,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 9c9325e0ad..d318be4b41 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index c8bed0d82a..2de21d086f 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 8dc5b31e04..3159610b02 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 852920808b..f6383fa019 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 cd074124a5..9ae8b6772e 100644 --- a/module-core_service-test-runner_services-for-title.html +++ b/module-core_service-test-runner_services-for-title.html @@ -278,13 +278,13 @@ as an array of strings.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 e666838191..29909ccb47 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 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 92aa3528eb..91d59aef6d 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index 5db8641799..1bd40d5ea3 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -285,13 +285,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_build-status.html b/module-services_build-status.html index 0f8d3652b8..3a23421b86 100644 --- a/module-services_build-status.html +++ b/module-services_build-status.html @@ -447,13 +447,13 @@ Determines the message and color of the badge according to the build status.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_color-formatters.html b/module-services_color-formatters.html index 381d86cbab..1ac311ea8a 100644 --- a/module-services_color-formatters.html +++ b/module-services_color-formatters.html @@ -1526,13 +1526,13 @@ The color defaults to red if the score does not matches with any of the grade va
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_contributor-count.html b/module-services_contributor-count.html index 4c1f83f453..9672ac11bb 100644 --- a/module-services_contributor-count.html +++ b/module-services_contributor-count.html @@ -530,13 +530,13 @@ Determines the message and color of the badge according to the contributor count
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_downloads.html b/module-services_downloads.html index def5a8fecb..e2e2c85cf9 100644 --- a/module-services_downloads.html +++ b/module-services_downloads.html @@ -540,13 +540,13 @@ this value as the prefix for versioned badges, e.g. foobar@v1.23. D
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic-common.html b/module-services_dynamic-common.html index b48b321d86..81ff641592 100644 --- a/module-services_dynamic-common.html +++ b/module-services_dynamic-common.html @@ -954,13 +954,13 @@ Sets the color of the badge to blue.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index 871eb71d16..45091c9410 100644 --- a/module-services_dynamic_json-path.html +++ b/module-services_dynamic_json-path.html @@ -417,13 +417,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_endpoint-common.html b/module-services_endpoint-common.html index a707bc4f11..999747cf7b 100644 --- a/module-services_endpoint-common.html +++ b/module-services_endpoint-common.html @@ -804,13 +804,13 @@ Optionally it prints those keys in the message to provide detailed feedback.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_licenses.html b/module-services_licenses.html index 1047e85edc..6225ea1564 100644 --- a/module-services_licenses.html +++ b/module-services_licenses.html @@ -644,13 +644,13 @@ Sets the badge color to the provided value, if not provided then the color is us
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_package-json-helpers.html b/module-services_package-json-helpers.html index 610f5425fc..bb907bbe26 100644 --- a/module-services_package-json-helpers.html +++ b/module-services_package-json-helpers.html @@ -650,13 +650,13 @@ Checks if the object has all the dependency types and the dependency types are v
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_php-version.html b/module-services_php-version.html index 77714bde97..9b2e8e0156 100644 --- a/module-services_php-version.html +++ b/module-services_php-version.html @@ -1466,13 +1466,13 @@ Return { numbers: [1,0,something big], modifier: 2, modifierCount: 1 }


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_pipenv-helpers.html b/module-services_pipenv-helpers.html index 0117e1261f..463bf87b4c 100644 --- a/module-services_pipenv-helpers.html +++ b/module-services_pipenv-helpers.html @@ -610,13 +610,13 @@ Checks if the lock file object has required properties and the properties are va
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_route-builder.html b/module-services_route-builder.html index 04700e0e04..f51923395d 100644 --- a/module-services_route-builder.html +++ b/module-services_route-builder.html @@ -615,13 +615,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index fa306d11dd..190f62bcc7 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index 1c8f8e37b8..780b8fd37d 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_text-formatters.html b/module-services_text-formatters.html index 417842010b..fd7aada046 100644 --- a/module-services_text-formatters.html +++ b/module-services_text-formatters.html @@ -1674,13 +1674,13 @@ The remaining stars are empty stars until the maximum number of stars is reached
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_validators.html b/module-services_validators.html index df72cfaa0a..274999963d 100644 --- a/module-services_validators.html +++ b/module-services_validators.html @@ -701,13 +701,13 @@ Some invalid values for this validator are: abc, 1.a, 1.0-, .1


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_version.html b/module-services_version.html index e060b979af..f07e950873 100644 --- a/module-services_version.html +++ b/module-services_version.html @@ -1876,13 +1876,13 @@ slice('2.4', 'patch') // returns null because the version string is not valid ac
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_website-status.html b/module-services_website-status.html new file mode 100644 index 0000000000..7c7f995a70 --- /dev/null +++ b/module-services_website-status.html @@ -0,0 +1,669 @@ + + + + + JSDoc: Module: services/website-status + + + + + + + + + + +
+ +

Module: services/website-status

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

Commonly used functions and utilities for tasks related to website status.

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

Members

+ + + +

(inner, constant) exampleQueryParams :object

+ + + + +
+

Example query param object. +Contains up_message, down_message, up_color and down_color properties.

+
+ + + +
Type:
+
    +
  • + +object + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

(inner, constant) queryParamSchema :Joi

+ + + + +
+

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

+
+ + + +
Type:
+
    +
  • + +Joi + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + + +

(inner) renderWebsiteStatus(options) → {object}

+ + + + + + +
+

Creates a badge object that displays information about website status.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +object + + + +

The options for rendering the status

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
isUp + + +boolean + + + + + + + + + + + +

Whether the website or service is up or down

upMessage + + +string + + + + + + <optional>
+ + + + + + 		+ + 'up' + +

The message to display when the website or service is up

downMessage + + +string + + + + + + <optional>
+ + + + + + 		+ + 'down' + +

The message to display when the website or service is down

upColor + + +string + + + + + + <optional>
+ + + + + + 		+ + 'brightgreen' + +

The color to use when the website or service is up

downColor + + +string + + + + + + <optional>
+ + + + + + 		+ + 'red' + +

The color to use when the website or service is down

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

An object with a message and a color property

+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + +
Example
+ + 
renderWebsiteStatus({ isUp: true }) // returns { message: 'up', color: 'brightgreen' }
+renderWebsiteStatus({ isUp: false }) // returns { message: 'down', color: 'red' }
+ + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time) +
+ + + + + \ No newline at end of file diff --git a/services_build-status.js.html b/services_build-status.js.html index 7287029a29..b07f647509 100644 --- a/services_build-status.js.html +++ b/services_build-status.js.html @@ -134,13 +134,13 @@ export { isBuildStatus, renderBuildStatusBadge }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_color-formatters.js.html b/services_color-formatters.js.html index 88cfbb55ca..37eb80561a 100644 --- a/services_color-formatters.js.html +++ b/services_color-formatters.js.html @@ -234,13 +234,13 @@ export {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_contributor-count.js.html b/services_contributor-count.js.html index 5e1100b613..cd4bc4efdf 100644 --- a/services_contributor-count.js.html +++ b/services_contributor-count.js.html @@ -79,13 +79,13 @@ export { contributorColor, renderContributorBadge }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_downloads.js.html b/services_downloads.js.html index 89c9c61d52..c8c6714b28 100644 --- a/services_downloads.js.html +++ b/services_downloads.js.html @@ -95,13 +95,13 @@ export { renderDownloadsBadge }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic-common.js.html b/services_dynamic-common.js.html index cd4a64986e..74aaef4981 100644 --- a/services_dynamic-common.js.html +++ b/services_dynamic-common.js.html @@ -136,13 +136,13 @@ export {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index 96c90839dc..bc2944283c 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_endpoint-common.js.html b/services_endpoint-common.js.html index 816b9bff30..fbb5ef6360 100644 --- a/services_endpoint-common.js.html +++ b/services_endpoint-common.js.html @@ -142,13 +142,13 @@ export { validateEndpointData, fetchEndpointData }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_licenses.js.html b/services_licenses.js.html index 9ce831e5c8..d733320326 100644 --- a/services_licenses.js.html +++ b/services_licenses.js.html @@ -195,13 +195,13 @@ export { licenseToColor, renderLicenseBadge }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_package-json-helpers.js.html b/services_package-json-helpers.js.html index 8fe776bf81..06ba31e7b7 100644 --- a/services_package-json-helpers.js.html +++ b/services_package-json-helpers.js.html @@ -114,13 +114,13 @@ export { isDependencyMap, isPackageJsonWithDependencies, getDependencyVersion }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index d6abe3aea6..9bb7f23c9d 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -221,13 +221,13 @@ export {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_php-version.js.html b/services_php-version.js.html index d6f31310d6..f590119981 100644 --- a/services_php-version.js.html +++ b/services_php-version.js.html @@ -335,13 +335,13 @@ export {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_pipenv-helpers.js.html b/services_pipenv-helpers.js.html index 92902eade8..fce08e420f 100644 --- a/services_pipenv-helpers.js.html +++ b/services_pipenv-helpers.js.html @@ -122,13 +122,13 @@ export { isLockfile, getDependencyVersion }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_route-builder.js.html b/services_route-builder.js.html index 2cc395f45a..bfa9f98380 100644 --- a/services_route-builder.js.html +++ b/services_route-builder.js.html @@ -99,13 +99,13 @@ export default class RouteBuilder {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index fcada8a527..e7ab3ce66f 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_test-validators.js.html b/services_test-validators.js.html index 678b9dac05..aaa84785a2 100644 --- a/services_test-validators.js.html +++ b/services_test-validators.js.html @@ -253,13 +253,13 @@ export {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_text-formatters.js.html b/services_text-formatters.js.html index 0673ff053a..fb4292ea69 100644 --- a/services_text-formatters.js.html +++ b/services_text-formatters.js.html @@ -246,13 +246,13 @@ export {
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_validators.js.html b/services_validators.js.html index 95bde0b93e..8cbcb9eaaf 100644 --- a/services_validators.js.html +++ b/services_validators.js.html @@ -117,13 +117,13 @@ export const fileSize = Joi.string()
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_version.js.html b/services_version.js.html index 991413701c..4ad7345725 100644 --- a/services_version.js.html +++ b/services_version.js.html @@ -293,13 +293,13 @@ export { latest, listCompare, slice, rangeStart, renderVersionBadge }
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/services_website-status.js.html b/services_website-status.js.html new file mode 100644 index 0000000000..4da9bae18b --- /dev/null +++ b/services_website-status.js.html @@ -0,0 +1,114 @@ + + + + + JSDoc: Source: services/website-status.js + + + + + + + + + + +
+ +

Source: services/website-status.js

+ + + + + + +
+
+ 
/**
+ * Commonly used functions and utilities for tasks related to website status.
+ *
+ * @module
+ */
+
+import Joi from 'joi'
+
+/**
+ * Joi schema for validating query params.
+ * Checks if the query params obect has valid up_message, down_message, up_color and down_color properties.
+ *
+ * @type {Joi}
+ */
+const queryParamSchema = Joi.object({
+  up_message: Joi.string(),
+  down_message: Joi.string(),
+  up_color: Joi.alternatives(Joi.string(), Joi.number()),
+  down_color: Joi.alternatives(Joi.string(), Joi.number()),
+}).required()
+
+/**
+ * Example query param object.
+ * Contains up_message, down_message, up_color and down_color properties.
+ *
+ * @type {object}
+ */
+const exampleQueryParams = {
+  up_message: 'online',
+  up_color: 'blue',
+  down_message: 'offline',
+  down_color: 'lightgrey',
+}
+
+/**
+ * Creates a badge object that displays information about website status.
+ *
+ * @param {object} options - The options for rendering the status
+ * @param {boolean} options.isUp - Whether the website or service is up or down
+ * @param {string} [options.upMessage='up'] - The message to display when the website or service is up
+ * @param {string} [options.downMessage='down'] - The message to display when the website or service is down
+ * @param {string} [options.upColor='brightgreen'] - The color to use when the website or service is up
+ * @param {string} [options.downColor='red'] - The color to use when the website or service is down
+ * @returns {object} An object with a message and a color property
+ * @example
+ * renderWebsiteStatus({ isUp: true }) // returns { message: 'up', color: 'brightgreen' }
+ * renderWebsiteStatus({ isUp: false }) // returns { message: 'down', color: 'red' }
+ */
+function renderWebsiteStatus({
+  isUp,
+  upMessage = 'up',
+  downMessage = 'down',
+  upColor = 'brightgreen',
+  downColor = 'red',
+}) {
+  if (isUp) {
+    return { message: upMessage, color: upColor }
+  } else {
+    return { message: downMessage, color: downColor }
+  }
+}
+
+export { queryParamSchema, exampleQueryParams, renderWebsiteStatus }
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time) +
+ + + + + diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 5a20d5f75c..dc095677bc 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -371,13 +371,13 @@ will review your contribution.
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-adding-new-config-values.html b/tutorial-adding-new-config-values.html index 21b51e62ff..aacc8fdb64 100644 --- a/tutorial-adding-new-config-values.html +++ b/tutorial-adding-new-config-values.html @@ -54,13 +54,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-authentication.html b/tutorial-authentication.html index 94d597e796..e51798fe2e 100644 --- a/tutorial-authentication.html +++ b/tutorial-authentication.html @@ -42,13 +42,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index e0d71bd39f..981a3f9b28 100644 --- a/tutorial-badge-urls.html +++ b/tutorial-badge-urls.html @@ -77,13 +77,13 @@ badge is for issues, and the parameters are :user/:repo.
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index e3c377dda1..9488774eee 100644 --- a/tutorial-code-walkthrough.html +++ b/tutorial-code-walkthrough.html @@ -229,13 +229,13 @@ result over the HTTPS connection.
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index 92b296bfd9..34bdbdab8b 100644 --- a/tutorial-deprecating-badges.html +++ b/tutorial-deprecating-badges.html @@ -143,13 +143,13 @@ t.create('no longer available (previously number of layers)')
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index e0242d94c7..3a89c06c1e 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index b22d269e73..af720e8463 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-logos.html b/tutorial-logos.html index f680beaaa0..671406cbd0 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -80,13 +80,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index 41132eb376..250c73a05b 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 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index cee6d9ecf1..017d4867d4 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -211,13 +211,13 @@ via local-shields-io-production.yml (see Home

Modules

Classes

Tutorials

Global

+

Home

Modules

Classes

Tutorials

Global


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-releases.html b/tutorial-releases.html index e3fed3efc9..062153ab3b 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index fe77d8256f..c1b3676068 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -174,13 +174,13 @@ Set public.requireCloudflare: true.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index 51975c412a..16f8c7e7cd 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -303,13 +303,13 @@ and create an API key for the YouTube Data API v3.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index 425a182a55..a43b6ad548 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -240,13 +240,13 @@ comment there instead.


- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-static-badges.html b/tutorial-static-badges.html index 302c789779..5733b6ad78 100644 --- a/tutorial-static-badges.html +++ b/tutorial-static-badges.html @@ -36,13 +36,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 10:18:51 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon Aug 21 2023 11:21:48 GMT+0000 (Coordinated Universal Time)