From 9811d54bf3b1b02f4876a38ce0ecec1848406178 Mon Sep 17 00:00:00 2001 From: chris48s Date: Mon, 1 May 2023 17:56:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20badges/s?= =?UTF-8?q?hields@96a06d48b4309147b225150482853198f88a77e7=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 +- 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 +- ...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 | 630 ++++++++++++++++++ ...ervices_steam_steam-base-BaseSteamAPI.html | 4 +- module-services_steam_steam-base.html | 4 +- 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 | 114 ++++ 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-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 +- 104 files changed, 948 insertions(+), 204 deletions(-) create mode 100644 module-services_route-builder.html create mode 100644 services_route-builder.js.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index 72a55a38e4..8f8591227c 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 09ae8b6c33..451b46a5b1 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 8794f04668..591a61db13 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 e410cbaa27..c3d1cb2c4c 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 6dd9ea5c5e..77f7d53cd5 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 be063f446d..eff657b6a0 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 7fee43efa4..704efb596d 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 e5039655ff..6462fac9ac 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -628,13 +628,13 @@ export default BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index 57dc1dce36..1d78183b03 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 7de6431ec9..cc8616ec61 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 64426d80d1..aab5d03be6 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 d974a09ae5..36762d18cc 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 15d34dc25f..4c4162c6da 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -630,13 +630,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 f966cd818b..a89043952f 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 868bb916b4..e1bba00b87 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 6b73b74987..f752f07c5a 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 119d35f3c7..e2e84b59fc 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 1d180c3313..889b283dac 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 424e62cba9..1d361b01c4 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 1ef3a19c14..8bc0e0907e 100644 --- a/global.html +++ b/global.html @@ -678,13 +678,13 @@
diff --git a/index.html b/index.html index 09739ac62b..07a6b349a6 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 8f1f6f02ea..bf6b99039e 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 875941607c..90b2d00d90 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index 7e796593b0..6a5a73aeeb 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index 1999864b0d..ad44be813d 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 5fabf83169..fec5ca83d7 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 7d93b00526..cacd9213ab 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 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index f0cd3e06a7..3aca4119ed 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 5540c7ed56..3449ff91f2 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 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 30e2b872b6..6e912afe2e 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 e9d991b692..8bdb81cb4a 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 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 d2dcb0b0d2..4d34a7d078 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 933b89c1b5..c1fa3202da 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 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 46924aee06..9d81e4a848 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 b4086dba59..8d661f34ab 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 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index eda3e37c8a..279d58d688 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index 2e7cfa7815..bbbf1fa8a0 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index 5cd0faecd5..726c96424f 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index f7db3cf8f2..1f07c47645 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index f2d048ffdb..f2c405f735 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 663a4b0cc6..e6f7ade3f8 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index 473d132580..100e717024 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 6799b5562a..5029a10e5d 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 38cf2d93da..961262c330 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 943dd4802a..7b203b95dc 100644 --- a/module-core_base-service_errors.html +++ b/module-core_base-service_errors.html @@ -312,13 +312,13 @@ badge when we catch and render the exception (Optional)


- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 8b263bece9..0bca71f7ca 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_resource-cache.html b/module-core_base-service_resource-cache.html index 0e2d610292..c13d573e5f 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index 91e8811425..2517823786 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server.html b/module-core_server_server.html index 1a000e6fa0..1c90dfb889 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 9c7d482b21..f2fc752d30 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 06c75a21a4..b9e9f79747 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 d3ab3d5eb5..dfd449cf80 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index 1457fb03c1..088a1be487 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 1a9ae4a05c..2ef3b819e0 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 018afbceed..4004a298bd 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 3e13566835..ca4f12dbe8 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 6a41ccbbce..dadf3a44ba 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 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 7d97f20086..485746da61 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index fe589ee447..716a66120c 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_build-status.html b/module-services_build-status.html index 3066f33674..ab36963bd3 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_color-formatters.html b/module-services_color-formatters.html index 7dc7663df4..9049407ff7 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_contributor-count.html b/module-services_contributor-count.html index 8ddf7aa75e..d874a5c7d8 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_downloads.html b/module-services_downloads.html index 0073f0fa50..40b76b895a 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic-common.html b/module-services_dynamic-common.html index f87e1287f0..ca202d6584 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index 1eba7f679e..194751997d 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_endpoint-common.html b/module-services_endpoint-common.html index 99576a52d9..e302224bde 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_licenses.html b/module-services_licenses.html index b4bf19d0e3..8ba4989442 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_package-json-helpers.html b/module-services_package-json-helpers.html index 214587795f..eef58ca6c6 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_php-version.html b/module-services_php-version.html index 456bc6b38b..46522f7953 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_pipenv-helpers.html b/module-services_pipenv-helpers.html index ae02f2c6d6..cae4ce0aa8 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_route-builder.html b/module-services_route-builder.html new file mode 100644 index 0000000000..045a1a59f6 --- /dev/null +++ b/module-services_route-builder.html @@ -0,0 +1,630 @@ + + + + + JSDoc: Class: module:services/route-builder + + + + + + + + + + +
+ +

Class: module:services/route-builder

+ + + + + + +
+ +
+ +

module:services/route-builder(attrs)

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

new module:services/route-builder(attrs)

+ + + + + + +
+

Creates a RouteBuilder object.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
attrs + + +object + + + +

Refer to individual attributes

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
base + + +string + + + +

Base URL, defaults to ''

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

Members

+ + + +

format

+ + + + +
+

Get the format components separated by '/'

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

Methods

+ + + + + + + +

push(format, capture) → {object}

+ + + + + + +
+

Saves the format and capture values in the RouteBuilder instance.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
format + + +string + + + +

Pattern based on path-to-regex, for example: (?:(.+)\.)?${serviceBaseUrl}

capture + + +string + + + +

Value to capture

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

RouteBuilder instance for chaining

+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + + + + + + + + +

toObject() → {object}

+ + + + + + +
+

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

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

Object containing base, format and capture properties of the RouteBuilder instance

+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time) +
+ + + + + \ No newline at end of file diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index fc3ecdde57..eb87e30944 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index 11f67a608f..416921210b 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_build-status.js.html b/services_build-status.js.html index 33b5f10702..2978daa3bf 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_color-formatters.js.html b/services_color-formatters.js.html index 8e261570cd..02cf6f4bf6 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_contributor-count.js.html b/services_contributor-count.js.html index d31c8a588a..16fbfa4812 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_downloads.js.html b/services_downloads.js.html index 98e430d130..a476ffa256 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic-common.js.html b/services_dynamic-common.js.html index 141797252e..795f3c39e8 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index 9453b49ee6..2bf85b5955 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_endpoint-common.js.html b/services_endpoint-common.js.html index 0c6ed3d599..a2fbf36043 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_licenses.js.html b/services_licenses.js.html index 58253e4d8e..b85d359e88 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_package-json-helpers.js.html b/services_package-json-helpers.js.html index 6bb0a9e3a6..c83fcdef20 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index 76369e42ce..35788fee00 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_php-version.js.html b/services_php-version.js.html index 4deb6ff4aa..1600386be8 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_pipenv-helpers.js.html b/services_pipenv-helpers.js.html index d34ee32067..4dfbef28fc 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_route-builder.js.html b/services_route-builder.js.html new file mode 100644 index 0000000000..4e538be7eb --- /dev/null +++ b/services_route-builder.js.html @@ -0,0 +1,114 @@ + + + + + JSDoc: Source: services/route-builder.js + + + + + + + + + + +
+ +

Source: services/route-builder.js

+ + + + + + +
+
+ 
/**
+ * Common functions and utilities for tasks related to route building
+ *
+ * @module
+ */
+
+import toArray from '../core/base-service/to-array.js'
+
+/*
+ * Factory class for building a BaseService `route` object. This class is useful
+ * in complex collections of service classes, when the URL is built
+ * conditionally.
+ *
+ * Patterns based on path-to-regex may obviate the need for this, though they
+ * haven't done so yet.
+ */
+export default class RouteBuilder {
+  /**
+   * Creates a RouteBuilder object.
+   *
+   * @param {object} attrs - Refer to individual attributes
+   * @param {string} attrs.base - Base URL, defaults to ''
+   */
+  constructor({ base = '' } = {}) {
+    this.base = base
+
+    this._formatComponents = []
+    this.capture = []
+  }
+
+  /**
+   * Get the format components separated by '/'
+   *
+   * @returns {string} Format components, for example: "format1/format2/format3"
+   */
+  get format() {
+    return this._formatComponents.join('/')
+  }
+
+  /**
+   * Saves the format and capture values in the RouteBuilder instance.
+   *
+   * @param {string} format - Pattern based on path-to-regex, for example: (?:(.+)\\.)?${serviceBaseUrl}
+   * @param {string} capture - Value to capture
+   * @returns {object} RouteBuilder instance for chaining
+   */
+  push(format, capture) {
+    this._formatComponents = this._formatComponents.concat(toArray(format))
+    this.capture = this.capture.concat(toArray(capture))
+    // Return `this` for chaining.
+    return this
+  }
+
+  /**
+   * Returns a new object based on RouteBuilder instance containing its base, format and capture properties.
+   *
+   * @returns {object} Object containing base, format and capture properties of the RouteBuilder instance
+   */
+  toObject() {
+    const { base, format, capture } = this
+    return { base, format, capture }
+  }
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time) +
+ + + + + diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index effa9f4f02..d1fd1ea697 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/services_test-validators.js.html b/services_test-validators.js.html index 63413f5515..f9dfbe67bc 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 9f7480afa5..0e27f1f124 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-adding-new-config-values.html b/tutorial-adding-new-config-values.html index 2bad09ec9b..b9391e312e 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-authentication.html b/tutorial-authentication.html index e1130de335..ea274bdd80 100644 --- a/tutorial-authentication.html +++ b/tutorial-authentication.html @@ -42,13 +42,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 444925ccc3..8e21eb9b37 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index 1c4a06a5c3..c3e9f71f14 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index 1027862c28..9816d53d6c 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 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index f6c27bdc54..aed5cb4b6d 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index dc4d830415..2434b7afb6 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-logos.html b/tutorial-logos.html index 3ebdd901d2..9c37bf9dbe 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -101,13 +101,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index 8162aeab07..b57bd15233 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index 6f24795cb1..f69c2ce7d4 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-releases.html b/tutorial-releases.html index 417ef6b5ab..ee355741e2 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index 770a8e6fdb..43df1e10a3 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index 07a293544e..f183030caf 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -288,13 +288,13 @@ and create an API key for the YouTube Data API v3.


- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index a633b0218d..b9faf6f7dd 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 May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-static-badges.html b/tutorial-static-badges.html index 4a37ad4694..1f62c13872 100644 --- a/tutorial-static-badges.html +++ b/tutorial-static-badges.html @@ -45,13 +45,13 @@
- Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:22:55 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.2 on Mon May 01 2023 17:56:01 GMT+0000 (Coordinated Universal Time)