From b2a56ada12812012c23226b1b7c2e54d5226d39d Mon Sep 17 00:00:00 2001 From: "repo-ranger[bot]" Date: Tue, 10 Jan 2023 20:51:27 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20badges/s?= =?UTF-8?q?hields@0c73b3591562d8478966299c035dfaba2059504c=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- badge-maker_lib_index.js.html | 4 +- badge-maker_lib_xml.js.html | 4 +- core_base-service_base-graphql.js.html | 4 +- core_base-service_base-json.js.html | 4 +- core_base-service_base-svg-scraping.js.html | 4 +- core_base-service_base-xml.js.html | 4 +- core_base-service_base-yaml.js.html | 4 +- core_base-service_base.js.html | 4 +- core_base-service_errors.js.html | 4 +- core_base-service_graphql.js.html | 4 +- core_base-service_resource-cache.js.html | 4 +- core_server_prometheus-metrics.js.html | 4 +- core_server_server.js.html | 4 +- ...-test-runner_create-service-tester.js.html | 4 +- ...ice-test-runner_icedfrisby-shields.js.html | 4 +- ...ice-test-runner_infer-pull-request.js.html | 4 +- core_service-test-runner_runner.js.html | 4 +- ...service-test-runner_service-tester.js.html | 4 +- ...ice-test-runner_services-for-title.js.html | 4 +- core_token-pooling_token-pool.js.html | 4 +- global.html | 4 +- index.html | 4 +- module-badge-maker.html | 4 +- module-badge-maker_lib_xml-ElementList.html | 4 +- module-badge-maker_lib_xml-XmlElement.html | 4 +- module-badge-maker_lib_xml.html | 4 +- ...le-core_base-service_base-BaseService.html | 4 +- ...rvice_base-graphql-BaseGraphqlService.html | 4 +- module-core_base-service_base-graphql.html | 4 +- ...ase-service_base-json-BaseJsonService.html | 4 +- module-core_base-service_base-json.html | 4 +- ...e-svg-scraping-BaseSvgScrapingService.html | 4 +- ...e-core_base-service_base-svg-scraping.html | 4 +- ..._base-service_base-xml-BaseXmlService.html | 4 +- module-core_base-service_base-xml.html | 4 +- ...ase-service_base-yaml-BaseYamlService.html | 4 +- module-core_base-service_base-yaml.html | 4 +- module-core_base-service_base.html | 4 +- ...e-core_base-service_errors-Deprecated.html | 4 +- ...e-service_errors-ImproperlyConfigured.html | 4 +- ...core_base-service_errors-Inaccessible.html | 4 +- ..._base-service_errors-InvalidParameter.html | 4 +- ...e_base-service_errors-InvalidResponse.html | 4 +- module-core_base-service_errors-NotFound.html | 4 +- ...se-service_errors-ShieldsRuntimeError.html | 4 +- module-core_base-service_errors.html | 4 +- module-core_base-service_graphql.html | 4 +- module-core_base-service_resource-cache.html | 4 +- module-core_server_server-Server.html | 4 +- module-core_server_server.html | 4 +- ...ice-test-runner_create-service-tester.html | 4 +- ...ervice-test-runner_icedfrisby-shields.html | 4 +- ...ervice-test-runner_infer-pull-request.html | 4 +- ...ore_service-test-runner_runner-Runner.html | 4 +- module-core_service-test-runner_runner.html | 4 +- ...t-runner_service-tester-ServiceTester.html | 4 +- ...re_service-test-runner_service-tester.html | 4 +- ...ervice-test-runner_services-for-title.html | 4 +- ...e-core_token-pooling_token-pool-Token.html | 4 +- ...re_token-pooling_token-pool-TokenPool.html | 4 +- module-core_token-pooling_token-pool.html | 4 +- module-services_build-status.html | 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 | 625 ++++++++++++++++++ ...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 | 137 ++++ 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, 966 insertions(+), 204 deletions(-) create mode 100644 module-services_pipenv-helpers.html create mode 100644 services_pipenv-helpers.js.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index b26acc4a5c..f3d2419dbf 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 b8c94acbec..2dcaad7ba3 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 a266b44241..ce65b30f12 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 8b666ce169..5407cecacc 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 135aef21db..ab0b83172c 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 f0c4eca6af..ac4123191e 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 fe5528e615..ba98366fe3 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 95245e133b..050516852b 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -619,13 +619,13 @@ export default BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index ed74c17dc2..4b097b8d43 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 10fa51f558..6c8440715d 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 669e5063b0..fb90fe53b7 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 2d9a932446..59478b8f1b 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 bd41a29df3..5968ce7ed8 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -629,13 +629,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 8232d81d1d..87c67ba1c6 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 1e4d88c269..1f80f0e8f7 100644 --- a/core_service-test-runner_icedfrisby-shields.js.html +++ b/core_service-test-runner_icedfrisby-shields.js.html @@ -140,13 +140,13 @@ export default factory
diff --git a/core_service-test-runner_infer-pull-request.js.html b/core_service-test-runner_infer-pull-request.js.html index 7ea4bd9026..4fed022f6d 100644 --- a/core_service-test-runner_infer-pull-request.js.html +++ b/core_service-test-runner_infer-pull-request.js.html @@ -138,13 +138,13 @@ export { parseGithubPullRequestUrl, parseGithubRepoSlug, inferPullRequest }
diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index 5387e0d216..5a75a18d17 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 45f0430c2a..979f59b533 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 bc7629a5f9..209a3313e0 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 366a41a1df..7f6e47f494 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 86d6c7636e..f0f5ba1004 100644 --- a/global.html +++ b/global.html @@ -678,13 +678,13 @@
diff --git a/index.html b/index.html index 9a2d47e764..f8da335121 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 699be69176..4f57c4dc59 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 090c087a9a..2c6ef361bc 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index 99886f2f0b..b3e72dba56 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index 6fae949403..9a74a07843 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index cc56956ce5..cb6d7fc067 100644 --- a/module-core_base-service_base-BaseService.html +++ b/module-core_base-service_base-BaseService.html @@ -739,13 +739,13 @@ defined in this.route.pattern or this.route.capture


- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 dd91225c1b..e6fd88f989 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index c8899bb114..80f2c7f75d 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 e5b4cb79d2..25b901a152 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 8ed7d3e947..b3f0825a93 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 1520890b0e..de62b7f416 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 395a5d8fe5..2db67bf44e 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 d5de615e17..2bd9f5e71a 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 6dc585dd89..6552335bfe 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 1c86de26ba..d666167a1c 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index 2c7aca6676..279d0516dc 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index 5e7a49d7ba..a24a6859e3 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index 22f1a6918c..d3902acded 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index 7a2f06c6be..07459f753a 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index 285987fc35..4d11e9aafb 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 13374fc833..9028352c12 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index abe4d60ca3..aae17b1e73 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 0ce0b2701a..f91d460088 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 802c089e39..1985c0d34e 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index d865993733..96e3b40777 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 726765ca53..8489247d93 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_resource-cache.html b/module-core_base-service_resource-cache.html index e116e6d062..37899be89e 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index 9fffe2c52e..a54cd870b2 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server.html b/module-core_server_server.html index ac3bc81691..f75f864e06 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -119,13 +119,13 @@
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 467c486234..b37b4d8b92 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 8d0a1333e1..fcd22dd4c7 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_infer-pull-request.html b/module-core_service-test-runner_infer-pull-request.html index a7966c9945..902418ca30 100644 --- a/module-core_service-test-runner_infer-pull-request.html +++ b/module-core_service-test-runner_infer-pull-request.html @@ -506,13 +506,13 @@ of a pull request from the environment variables.


- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 bbb9cdc7de..a596cce758 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index be4f77599c..a5cdfde124 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 c0490226bc..59e4362658 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 00712d7d84..e19dd043a6 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 70e8fe9f3a..bf14d867c2 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 274e7f3a93..fba2fc14f8 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 a1c5798f20..2b8bd34345 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index 58828dd6f8..2d15bf5f0d 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_build-status.html b/module-services_build-status.html index 27d84d1ded..c4f32dd63a 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_color-formatters.html b/module-services_color-formatters.html index 538052698e..97aa5a6a03 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_contributor-count.html b/module-services_contributor-count.html index 0add8c8616..1c924aff47 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_downloads.html b/module-services_downloads.html index 5be08f7dfd..feb3f0331b 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic-common.html b/module-services_dynamic-common.html index 48877fbe14..6c46cee26e 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index 47e3aea5e0..efba4122f5 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_endpoint-common.html b/module-services_endpoint-common.html index 432932eabc..3045e0c1e0 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_licenses.html b/module-services_licenses.html index 0f0b69be4d..fabacef2af 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_package-json-helpers.html b/module-services_package-json-helpers.html index 41bb528c5d..885e8a2408 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_php-version.html b/module-services_php-version.html index 89d1fa4c0c..0ab8473f8a 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_pipenv-helpers.html b/module-services_pipenv-helpers.html new file mode 100644 index 0000000000..0cfe98efa5 --- /dev/null +++ b/module-services_pipenv-helpers.html @@ -0,0 +1,625 @@ + + + + + JSDoc: Module: services/pipenv-helpers + + + + + + + + + + +
+ +

Module: services/pipenv-helpers

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

Common functions and utilities for tasks related to pipenv

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

Members

+ + + +

(inner, constant) isDependency :Joi

+ + + + +
+

Joi schema for validating dependency.

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

(inner, constant) isLockfile :Joi

+ + + + +
+

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

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

Methods

+ + + + + + + +

(inner) getDependencyVersion(attrs) → {object}

+ + + + + + +
+

Determines the dependency version based on the dependency type.

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

Refer to individual attributes

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
kind + + +string + + + +

Wanted dependency type ('dev' or 'default'), defaults to 'default'

wantedDependency + + +string + + + +

Name of the wanted dependency

lockfileData + + +object + + + +

Object containing lock file data

+ +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Throws:
+
    +
  • + +
    +
    +
    +
      +
    • Error if unknown dependency type provided
      • +
    +
    +
    +
    +
    +
    +
    + Type +
    +
    + +Error + + +
    +
    +
    +
    +
    + +
    • + +
  • + +
    +
    +
    +
      +
    • Error if wanted dependency is not present in lock file data
      • +
    +
    +
    +
    +
    +
    +
    + Type +
    +
    + +InvalidParameter + + +
    +
    +
    +
    +
    + +
    • + +
  • + +
    +
    +
    +
      +
    • Error if version or ref is not present for the wanted dependency
      • +
    +
    +
    +
    +
    +
    +
    + Type +
    +
    + +InvalidParameter + + +
    +
    +
    +
    +
    + +
    • +
+ + +
Returns:
+ + +
+

Object containing wanted dependency version or ref

+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 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 fe5992ee1f..8db95edec3 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index f680aedee9..62d6cddab7 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_build-status.js.html b/services_build-status.js.html index ad57c3afe5..a1afcc4342 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_color-formatters.js.html b/services_color-formatters.js.html index ba6b41698d..62108b523e 100644 --- a/services_color-formatters.js.html +++ b/services_color-formatters.js.html @@ -234,13 +234,13 @@ export {
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_contributor-count.js.html b/services_contributor-count.js.html index 9277c75ce7..e0f26daa4c 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_downloads.js.html b/services_downloads.js.html index 461d04673d..a140eecda0 100644 --- a/services_downloads.js.html +++ b/services_downloads.js.html @@ -95,13 +95,13 @@ export { renderDownloadsBadge }
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic-common.js.html b/services_dynamic-common.js.html index 2ccdd6dc7a..f89e9cf726 100644 --- a/services_dynamic-common.js.html +++ b/services_dynamic-common.js.html @@ -136,13 +136,13 @@ export {
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index 3421d3cf29..72ab14771c 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_endpoint-common.js.html b/services_endpoint-common.js.html index 993a3453af..3f861ed471 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_licenses.js.html b/services_licenses.js.html index 82b92fd7c8..dc26ed8019 100644 --- a/services_licenses.js.html +++ b/services_licenses.js.html @@ -195,13 +195,13 @@ export { licenseToColor, renderLicenseBadge }
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_package-json-helpers.js.html b/services_package-json-helpers.js.html index 83d67fcfbe..3a37d86d32 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index 8a7c21a9c7..9f5e93f755 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -223,13 +223,13 @@ export {
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_php-version.js.html b/services_php-version.js.html index 29b6fec39b..3f25e63fe6 100644 --- a/services_php-version.js.html +++ b/services_php-version.js.html @@ -335,13 +335,13 @@ export {
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_pipenv-helpers.js.html b/services_pipenv-helpers.js.html new file mode 100644 index 0000000000..b936bfdb37 --- /dev/null +++ b/services_pipenv-helpers.js.html @@ -0,0 +1,137 @@ + + + + + JSDoc: Source: services/pipenv-helpers.js + + + + + + + + + + +
+ +

Source: services/pipenv-helpers.js

+ + + + + + +
+
+ 
/**
+ * Common functions and utilities for tasks related to pipenv
+ *
+ * @module
+ */
+
+import Joi from 'joi'
+import { InvalidParameter } from './index.js'
+
+/**
+ * Joi schema for validating dependency.
+ *
+ * @type {Joi}
+ */
+const isDependency = Joi.object({
+  version: Joi.string(),
+  ref: Joi.string(),
+}).required()
+
+/**
+ * Joi schema for validating lock file object.
+ * Checks if the lock file object has required properties and the properties are valid.
+ *
+ * @type {Joi}
+ */
+const isLockfile = Joi.object({
+  _meta: Joi.object({
+    requires: Joi.object({
+      python_version: Joi.string(),
+    }).required(),
+  }).required(),
+  default: Joi.object().pattern(Joi.string(), isDependency),
+  develop: Joi.object().pattern(Joi.string(), isDependency),
+}).required()
+
+/**
+ * Determines the dependency version based on the dependency type.
+ *
+ * @param {object} attrs - Refer to individual attributes
+ * @param {string} attrs.kind - Wanted dependency type ('dev' or 'default'), defaults to 'default'
+ * @param {string} attrs.wantedDependency - Name of the wanted dependency
+ * @param {object} attrs.lockfileData - Object containing lock file data
+ * @throws {Error} - Error if unknown dependency type provided
+ * @throws {InvalidParameter} - Error if wanted dependency is not present in lock file data
+ * @throws {InvalidParameter} - Error if version or ref is not present for the wanted dependency
+ * @returns {object} Object containing wanted dependency version or ref
+ */
+function getDependencyVersion({
+  kind = 'default',
+  wantedDependency,
+  lockfileData,
+}) {
+  let dependenciesOfKind
+  if (kind === 'dev') {
+    dependenciesOfKind = lockfileData.develop
+  } else if (kind === 'default') {
+    dependenciesOfKind = lockfileData.default
+  } else {
+    throw Error(`Not very kind: ${kind}`)
+  }
+
+  if (!(wantedDependency in dependenciesOfKind)) {
+    throw new InvalidParameter({
+      prettyMessage: `${kind} dependency not found`,
+    })
+  }
+
+  const { version, ref } = dependenciesOfKind[wantedDependency]
+
+  if (version) {
+    // Strip the `==` which is always present.
+    return { version: version.replace('==', '') }
+  } else if (ref) {
+    if (ref.length === 40) {
+      // assume it is a commit hash
+      return { ref: ref.substring(0, 7) }
+    }
+    return { ref } // tag
+  } else {
+    throw new InvalidParameter({
+      prettyMessage: `No version or ref for ${wantedDependency}`,
+    })
+  }
+}
+
+export { isLockfile, getDependencyVersion }
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time) +
+ + + + + diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 3b087f4c49..b3abb145bd 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/services_test-validators.js.html b/services_test-validators.js.html index 3048b15d02..6f5b20b861 100644 --- a/services_test-validators.js.html +++ b/services_test-validators.js.html @@ -253,13 +253,13 @@ export {
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 20b239d7c2..40ae5b2278 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -371,13 +371,13 @@ will review your contribution.
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-adding-new-config-values.html b/tutorial-adding-new-config-values.html index 7da95aeb1e..67713968b4 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-authentication.html b/tutorial-authentication.html index ca1a8affa5..e751e9d10b 100644 --- a/tutorial-authentication.html +++ b/tutorial-authentication.html @@ -42,13 +42,13 @@
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 17a942a17f..4ff4814ad5 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index 32c7ef40a7..9acaa240dd 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index a5cf545e8a..035dfcfd3f 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index 7a3fd514dd..76ed3de1b9 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index bba9817098..79a7b8dba1 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-logos.html b/tutorial-logos.html index 9dcff7e197..37c5402808 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -101,13 +101,13 @@
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index e30dff7ab3..50f8f53e0d 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.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index cf8b130680..dc2bb5e51d 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -229,13 +229,13 @@ via local-shields-io-production.yml (see Home

Modules

Classes

Tutorials

Global

+

Home

Modules

Classes

Tutorials

Global


- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-releases.html b/tutorial-releases.html index db71241217..84b0caa81a 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index 0e8f2a84f5..f683ea122b 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -162,13 +162,13 @@ Set public.requireCloudflare: true.


- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index b361531235..a265597313 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -283,13 +283,13 @@ and create an API key for the YouTube Data API v3.


- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index 566b166321..01a1d7e7f9 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -240,13 +240,13 @@ comment there instead.


- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-static-badges.html b/tutorial-static-badges.html index a8f4651cd8..b6479eb38e 100644 --- a/tutorial-static-badges.html +++ b/tutorial-static-badges.html @@ -45,13 +45,13 @@
- Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 19:40:26 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 4.0.0 on Tue Jan 10 2023 20:51:25 GMT+0000 (Coordinated Universal Time)