From c944fb219455f2c78feabda99e7ef53b7aa12613 Mon Sep 17 00:00:00 2001 From: "repo-ranger[bot]" Date: Tue, 26 Oct 2021 23:21:16 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20e4e7b?= =?UTF-8?q?09009e1ed5c17a983e2393b3e5c4fe01942=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_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 | 394 +++++++++++++++++- 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_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_dynamic_json-path.html | 4 +- ...ervices_steam_steam-base-BaseSteamAPI.html | 4 +- module-services_steam_steam-base.html | 4 +- services_downloads.js.html | 103 +++++ services_dynamic_json-path.js.html | 4 +- services_packagist_packagist-base.js.html | 4 +- services_steam_steam-base.js.html | 4 +- services_test-validators.js.html | 4 +- tutorial-TUTORIAL.html | 4 +- tutorial-adding-new-config-values.html | 4 +- tutorial-badge-urls.html | 4 +- tutorial-code-walkthrough.html | 4 +- tutorial-deprecating-badges.html | 4 +- tutorial-input-validation.html | 4 +- tutorial-json-format.html | 4 +- tutorial-logos.html | 4 +- tutorial-performance-testing.html | 4 +- tutorial-production-hosting.html | 4 +- tutorial-releases.html | 4 +- tutorial-self-hosting.html | 4 +- tutorial-server-secrets.html | 4 +- tutorial-service-tests.html | 4 +- 81 files changed, 653 insertions(+), 160 deletions(-) create mode 100644 services_downloads.js.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index a6bd45feb7..b84f023391 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 03ddb5ef9e..54d8cfc8a3 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 4904a76dc6..552554c4eb 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 e42af92390..a2895f21cd 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 5e7936dc00..d63249a6bc 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 b2767b4dc0..15b0de14b4 100644 --- a/core_base-service_base-xml.js.html +++ b/core_base-service_base-xml.js.html @@ -105,13 +105,13 @@ export default BaseXmlService
diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index 64d1eb8265..2bee341f69 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 cf9b442658..d05889fce7 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -606,13 +606,13 @@ export default BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index 57306ae631..58ed7f31fc 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 8fa143b81d..bf3d988884 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_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index 3a6e5d5dd2..68419b4302 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 99202854fd..47eca92d20 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -593,13 +593,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 fdcef82244..8a01cf8995 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 1564bb2c86..5b14e26397 100644 --- a/core_service-test-runner_icedfrisby-shields.js.html +++ b/core_service-test-runner_icedfrisby-shields.js.html @@ -125,13 +125,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 1fa0d65239..ab90b414ba 100644 --- a/core_service-test-runner_infer-pull-request.js.html +++ b/core_service-test-runner_infer-pull-request.js.html @@ -136,13 +136,13 @@ export { parseGithubPullRequestUrl, parseGithubRepoSlug, inferPullRequest }
diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index 200e254373..25dda2a9c3 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 a1a1530555..74bef3dee6 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 df98601b9d..750c540295 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 7a8894a298..4e31589062 100644 --- a/core_token-pooling_token-pool.js.html +++ b/core_token-pooling_token-pool.js.html @@ -369,13 +369,13 @@ export { sanitizeToken, Token, TokenPool }
diff --git a/global.html b/global.html index db0d4b9539..3381a9adcc 100644 --- a/global.html +++ b/global.html @@ -663,6 +663,396 @@ + + + + + +

renderDownloadsBadge(attrs) → {object}

+ + + + + + +
+

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

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

Refer to individual attrs

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
downloads + + +number + + + + + + + + + +

Number of downloads

interval + + +string + + + + + + <optional>
+ + + + + +

Period or interval the downloads occurred +(e.g. day, week, month). If provided then this Will be reflected +in the badge message unless overridden by other message-related parameters

version + + +string + + + + + + <optional>
+ + + + + +

Version or tag that was downloaded +which will be reflected in the badge label (unless the label is overridden)

labelOverride + + +string + + + + + + <optional>
+ + + + + +

If provided then the badge label is set to this +value overriding any other label-related parameters

colorOverride + + +string + + + + + + <optional>
+ + + + + +

If provided then the badge color is set to this +value instead of the color being based on the count of downloads

messageSuffixOverride + + +string + + + + + + <optional>
+ + + + + +

If provided then the badge message will +will have this value added to the download count, separated with a space

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

Badge

+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + + + @@ -678,13 +1068,13 @@
diff --git a/index.html b/index.html index a561e7526f..245b44ab6e 100644 --- a/index.html +++ b/index.html @@ -217,13 +217,13 @@ under their terms and license.


diff --git a/module-badge-maker.html b/module-badge-maker.html index 337f97aff1..2272ca9def 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -381,13 +381,13 @@
diff --git a/module-badge-maker_lib_xml-ElementList.html b/module-badge-maker_lib_xml-ElementList.html index 8d22d1676f..9c258646bf 100644 --- a/module-badge-maker_lib_xml-ElementList.html +++ b/module-badge-maker_lib_xml-ElementList.html @@ -157,13 +157,13 @@ like an XmlElement but renders multiple XML tags (not wrapped in a ).


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index 3f08373928..dcfe5598db 100644 --- a/module-badge-maker_lib_xml-XmlElement.html +++ b/module-badge-maker_lib_xml-XmlElement.html @@ -468,13 +468,13 @@ element will be rendered as a self-closing element.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index 9496563beb..8ac75ebaef 100644 --- a/module-badge-maker_lib_xml.html +++ b/module-badge-maker_lib_xml.html @@ -80,13 +80,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 14b1d01bac..e45f092c55 100644 --- a/module-core_base-service_base-BaseService.html +++ b/module-core_base-service_base-BaseService.html @@ -737,13 +737,13 @@ defined in this.route.pattern or this.route.capture


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 ee86f42d02..231b381d1d 100644 --- a/module-core_base-service_base-graphql-BaseGraphqlService.html +++ b/module-core_base-service_base-graphql-BaseGraphqlService.html @@ -823,13 +823,13 @@ an InvalidResponse.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index f6338ea9cb..6770150b67 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 eff93a93d5..22f7b69904 100644 --- a/module-core_base-service_base-json-BaseJsonService.html +++ b/module-core_base-service_base-json-BaseJsonService.html @@ -668,13 +668,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 8b215cc49d..901994e8ea 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 b66fcb88cb..f780ee6a29 100644 --- a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html +++ b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html @@ -759,13 +759,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 5bd075631d..0fc398129d 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 ddd6f30403..d0d5fe35af 100644 --- a/module-core_base-service_base-xml-BaseXmlService.html +++ b/module-core_base-service_base-xml-BaseXmlService.html @@ -551,13 +551,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 1dcdf61dea..87edfc7c47 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 9cfdf6f9e8..dc1627bf85 100644 --- a/module-core_base-service_base-yaml-BaseYamlService.html +++ b/module-core_base-service_base-yaml-BaseYamlService.html @@ -548,13 +548,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index ba492f8ef7..bdeaf4adfd 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index 5e7f8e154b..d49fae03bb 100644 --- a/module-core_base-service_base.html +++ b/module-core_base-service_base.html @@ -1160,13 +1160,13 @@ when the parameter is absent. (Note that in,
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index 0298f6467f..09368b3d7b 100644 --- a/module-core_base-service_errors-Deprecated.html +++ b/module-core_base-service_errors-Deprecated.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index b93ea1d1e5..0a2e2f71a2 100644 --- a/module-core_base-service_errors-ImproperlyConfigured.html +++ b/module-core_base-service_errors-ImproperlyConfigured.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index 21c9f96190..66e8b14dd1 100644 --- a/module-core_base-service_errors-Inaccessible.html +++ b/module-core_base-service_errors-Inaccessible.html @@ -206,13 +206,13 @@ or to wrap a 5XX response


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 08db5c4cae..9c5aef5a6b 100644 --- a/module-core_base-service_errors-InvalidParameter.html +++ b/module-core_base-service_errors-InvalidParameter.html @@ -206,13 +206,13 @@ is invalid or unexpected


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index 17ad4fa584..ecc014d965 100644 --- a/module-core_base-service_errors-InvalidResponse.html +++ b/module-core_base-service_errors-InvalidResponse.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 4a9df275c1..834d5d5d03 100644 --- a/module-core_base-service_errors-NotFound.html +++ b/module-core_base-service_errors-NotFound.html @@ -205,13 +205,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 0ad67debea..c629330670 100644 --- a/module-core_base-service_errors-ShieldsRuntimeError.html +++ b/module-core_base-service_errors-ShieldsRuntimeError.html @@ -378,13 +378,13 @@ should override this method.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index a4f23887e7..4ed7646328 100644 --- a/module-core_base-service_errors.html +++ b/module-core_base-service_errors.html @@ -348,13 +348,13 @@ badge when we catch and render the exception (Optional)


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index b73ed2cb3f..01f8a55039 100644 --- a/module-core_base-service_graphql.html +++ b/module-core_base-service_graphql.html @@ -248,13 +248,13 @@ but can't use that due to incorrect packaging.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index b90ba85701..4a2ffb840c 100644 --- a/module-core_server_server-Server.html +++ b/module-core_server_server-Server.html @@ -675,13 +675,13 @@ Start listening for requests on this.baseUrl()


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server.html b/module-core_server_server.html index 40f8761ee2..785272534f 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 855a505a97..f92578c06a 100644 --- a/module-core_service-test-runner_create-service-tester.html +++ b/module-core_service-test-runner_create-service-tester.html @@ -188,13 +188,13 @@ service.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 d3e9d0b469..53abf3b345 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -244,13 +244,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 a7ddfce94e..9b9970445f 100644 --- a/module-core_service-test-runner_infer-pull-request.html +++ b/module-core_service-test-runner_infer-pull-request.html @@ -464,13 +464,13 @@ of a pull request from the environment variables.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 fe6156887b..0ee936a7cf 100644 --- a/module-core_service-test-runner_runner-Runner.html +++ b/module-core_service-test-runner_runner-Runner.html @@ -562,13 +562,13 @@ overridden on instances.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index 86a9ed7816..cad8099ef9 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 8605ca04b1..6702f60601 100644 --- a/module-core_service-test-runner_service-tester-ServiceTester.html +++ b/module-core_service-test-runner_service-tester-ServiceTester.html @@ -1120,13 +1120,13 @@ the CLI, or directly on the tester.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 32479d73eb..0731c18f26 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 b489a5b09e..4327eaf0ab 100644 --- a/module-core_service-test-runner_services-for-title.html +++ b/module-core_service-test-runner_services-for-title.html @@ -236,13 +236,13 @@ as an array of strings.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 bd6b9c2474..bc733beb05 100644 --- a/module-core_token-pooling_token-pool-Token.html +++ b/module-core_token-pooling_token-pool-Token.html @@ -709,13 +709,13 @@ stable ordering for a valid priority queue.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 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 e5d02fdfe7..65f0fe4f33 100644 --- a/module-core_token-pooling_token-pool-TokenPool.html +++ b/module-core_token-pooling_token-pool-TokenPool.html @@ -893,13 +893,13 @@ indicate it should not be reused.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index bd4f85a28b..89c2236590 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -243,13 +243,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index b94a575ed8..5ac8599020 100644 --- a/module-services_dynamic_json-path.html +++ b/module-services_dynamic_json-path.html @@ -536,13 +536,13 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index 4ff4f3b273..5d0416f076 100644 --- a/module-services_steam_steam-base-BaseSteamAPI.html +++ b/module-services_steam_steam-base-BaseSteamAPI.html @@ -374,13 +374,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index df95e72643..7f3510d549 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -77,13 +77,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/services_downloads.js.html b/services_downloads.js.html new file mode 100644 index 0000000000..af41b18aa3 --- /dev/null +++ b/services_downloads.js.html @@ -0,0 +1,103 @@ + + + + + JSDoc: Source: services/downloads.js + + + + + + + + + + +
+ +

Source: services/downloads.js

+ + + + + + +
+
+ 
import { downloadCount } from './color-formatters.js'
+import { metric } from './text-formatters.js'
+
+/**
+ * Handles rendering concerns of badges that display
+ * download counts, with override/customization support
+ *
+ * @param {object} attrs Refer to individual attrs
+ * @param {number} attrs.downloads Number of downloads
+ * @param {string} [attrs.interval] Period or interval the downloads occurred
+ *    (e.g. day, week, month). If provided then this Will be reflected
+ *    in the badge message unless overridden by other message-related parameters
+ * @param {string} [attrs.version] Version or tag that was downloaded
+ *    which will be reflected in the badge label (unless the label is overridden)
+ * @param {string} [attrs.labelOverride] If provided then the badge label is set to this
+ *    value overriding any other label-related parameters
+ * @param {string} [attrs.colorOverride] If provided then the badge color is set to this
+ *    value instead of the color being based on the count of downloads
+ * @param {string} [attrs.messageSuffixOverride] If provided then the badge message will
+ *    will have this value added to the download count, separated with a space
+ * @returns {object} Badge
+ */
+function renderDownloadsBadge({
+  downloads,
+  interval,
+  version,
+  labelOverride,
+  colorOverride,
+  messageSuffixOverride,
+}) {
+  let messageSuffix = ''
+  if (messageSuffixOverride) {
+    messageSuffix = ` ${messageSuffixOverride}`
+  } else if (interval) {
+    messageSuffix = `/${interval}`
+  }
+
+  let label
+  if (labelOverride) {
+    label = labelOverride
+  } else if (version) {
+    label = `downloads@${version}`
+  }
+
+  return {
+    label,
+    color: colorOverride || downloadCount(downloads),
+    message: `${metric(downloads)}${messageSuffix}`,
+  }
+}
+
+export { renderDownloadsBadge }
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time) +
+ + + + + diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index dda459c83c..526f4acb29 100644 --- a/services_dynamic_json-path.js.html +++ b/services_dynamic_json-path.js.html @@ -114,13 +114,13 @@ export default superclass =>
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index 458fad9486..a4dca5da71 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -144,13 +144,13 @@ export {
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 19dd37190e..15c4784e2e 100644 --- a/services_steam_steam-base.js.html +++ b/services_steam_steam-base.js.html @@ -92,13 +92,13 @@ export default BaseSteamAPI
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/services_test-validators.js.html b/services_test-validators.js.html index 2fe5788f3c..dd89eafad1 100644 --- a/services_test-validators.js.html +++ b/services_test-validators.js.html @@ -217,13 +217,13 @@ export {
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:54 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 51b1b392ac..43712cb002 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -371,13 +371,13 @@ will review your contribution.
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-adding-new-config-values.html b/tutorial-adding-new-config-values.html index e3a2a952a6..3b138b9334 100644 --- a/tutorial-adding-new-config-values.html +++ b/tutorial-adding-new-config-values.html @@ -54,13 +54,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 12845552fe..e8c56e179a 100644 --- a/tutorial-badge-urls.html +++ b/tutorial-badge-urls.html @@ -71,13 +71,13 @@ badge is for issues, and the parameters are :user/:repo.
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index 831624d736..b80cf7667c 100644 --- a/tutorial-code-walkthrough.html +++ b/tutorial-code-walkthrough.html @@ -234,13 +234,13 @@ result over the HTTPS connection.
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index 087ec98c44..a30c540fa6 100644 --- a/tutorial-deprecating-badges.html +++ b/tutorial-deprecating-badges.html @@ -134,13 +134,13 @@ t.create('no longer available (previously number of layers)')
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index a8cab8c121..6ab9e670bb 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index 5aee65a9a0..66051b6f47 100644 --- a/tutorial-json-format.html +++ b/tutorial-json-format.html @@ -54,13 +54,13 @@ if you have any queries regarding the JSON format.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-logos.html b/tutorial-logos.html index c017418021..510608c365 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -90,13 +90,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index d40389f359..1a86f398d9 100644 --- a/tutorial-performance-testing.html +++ b/tutorial-performance-testing.html @@ -70,13 +70,13 @@ node --prof-process --preprocess -j isolate-00000244AB6ED3B0-11920-v8.log | flam
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index 4cc33bc2da..4382ba0f97 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -247,13 +247,13 @@ the server. It's generously donated by Sent
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-releases.html b/tutorial-releases.html index ad4185cdde..4d66727a0e 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index 93852e9f05..2d47d0368a 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -170,13 +170,13 @@ Set public.requireCloudflare: true.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index 323269b030..9e59f94516 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -260,13 +260,13 @@ and create an API key for the YouTube Data API v3.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index 3c42b9e2b1..e71b1ce9fd 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -240,13 +240,13 @@ comment there instead.


- Documentation generated by JSDoc 3.6.7 on Sat Oct 23 2021 03:43:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Tue Oct 26 2021 23:20:55 GMT+0000 (Coordinated Universal Time)