From 5cb729b8201c5c4994dddc15b7a4928ab1d6d555 Mon Sep 17 00:00:00 2001 From: calebcartwright Date: Tue, 29 Jun 2021 16:54:28 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=202dfe9?= =?UTF-8?q?90e089245f92142a54a260e5eb557703311=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 | 159 +++++++++++- index.html | 4 +- module-badge-maker.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 +- module.exports.html | 4 +- services_criterion_criterion.service.js.html | 4 +- services_dynamic_json-path.js.html | 4 +- ...s_github_github-total-star.service.js.html | 4 +- ..._osslifecycle_osslifecycle.service.js.html | 4 +- services_packagist_packagist-base.js.html | 4 +- services_steam_steam-base.js.html | 4 +- services_test-validators.js.html | 232 ++++++++++++++++++ tutorial-TUTORIAL.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 +- 82 files changed, 549 insertions(+), 162 deletions(-) create mode 100644 services_test-validators.js.html diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index 85dac2f563..5c021c121d 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 3f4b7a5059..fc187ec651 100644 --- a/badge-maker_lib_xml.js.html +++ b/badge-maker_lib_xml.js.html @@ -112,13 +112,13 @@ module.exports = { escapeXml, stripXmlWhitespace, XmlElement }
diff --git a/core_base-service_base-graphql.js.html b/core_base-service_base-graphql.js.html index 36d4cd031f..88dd7ea093 100644 --- a/core_base-service_base-graphql.js.html +++ b/core_base-service_base-graphql.js.html @@ -132,13 +132,13 @@ module.exports = BaseGraphqlService
diff --git a/core_base-service_base-json.js.html b/core_base-service_base-json.js.html index cffef3a6ec..6deb09ed3e 100644 --- a/core_base-service_base-json.js.html +++ b/core_base-service_base-json.js.html @@ -93,13 +93,13 @@ module.exports = BaseJsonService
diff --git a/core_base-service_base-svg-scraping.js.html b/core_base-service_base-svg-scraping.js.html index b6b811f25d..cc758df25b 100644 --- a/core_base-service_base-svg-scraping.js.html +++ b/core_base-service_base-svg-scraping.js.html @@ -129,13 +129,13 @@ module.exports = BaseSvgScrapingService
diff --git a/core_base-service_base-xml.js.html b/core_base-service_base-xml.js.html index b904fcb75a..1802de7c7b 100644 --- a/core_base-service_base-xml.js.html +++ b/core_base-service_base-xml.js.html @@ -107,13 +107,13 @@ module.exports = BaseXmlService
diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index d1666cdc06..98f1c09517 100644 --- a/core_base-service_base-yaml.js.html +++ b/core_base-service_base-yaml.js.html @@ -111,13 +111,13 @@ module.exports = BaseYamlService
diff --git a/core_base-service_base.js.html b/core_base-service_base.js.html index c509536470..2dfa8441ba 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -604,13 +604,13 @@ module.exports = BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index bee4ce81ad..dcd4eb41bb 100644 --- a/core_base-service_errors.js.html +++ b/core_base-service_errors.js.html @@ -257,13 +257,13 @@ module.exports = {
diff --git a/core_base-service_graphql.js.html b/core_base-service_graphql.js.html index 698e9e9ef3..ab93f55562 100644 --- a/core_base-service_graphql.js.html +++ b/core_base-service_graphql.js.html @@ -88,13 +88,13 @@ module.exports = { mergeQueries }
diff --git a/core_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index 138a6760d2..1aab1ad2a9 100644 --- a/core_server_prometheus-metrics.js.html +++ b/core_server_prometheus-metrics.js.html @@ -123,13 +123,13 @@ module.exports = class PrometheusMetrics {
diff --git a/core_server_server.js.html b/core_server_server.js.html index 5134ecf509..8cab14356c 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -561,13 +561,13 @@ module.exports = Server
diff --git a/core_service-test-runner_create-service-tester.js.html b/core_service-test-runner_create-service-tester.js.html index e3999b5ab8..cdf67b05e6 100644 --- a/core_service-test-runner_create-service-tester.js.html +++ b/core_service-test-runner_create-service-tester.js.html @@ -69,13 +69,13 @@ module.exports = createServiceTester
diff --git a/core_service-test-runner_icedfrisby-shields.js.html b/core_service-test-runner_icedfrisby-shields.js.html index 8771285939..d79218d84a 100644 --- a/core_service-test-runner_icedfrisby-shields.js.html +++ b/core_service-test-runner_icedfrisby-shields.js.html @@ -124,13 +124,13 @@ module.exports = factory
diff --git a/core_service-test-runner_infer-pull-request.js.html b/core_service-test-runner_infer-pull-request.js.html index c41abe0211..7c9cce95bb 100644 --- a/core_service-test-runner_infer-pull-request.js.html +++ b/core_service-test-runner_infer-pull-request.js.html @@ -141,13 +141,13 @@ module.exports = {
diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index 5a1ff5538e..bc369cd4ee 100644 --- a/core_service-test-runner_runner.js.html +++ b/core_service-test-runner_runner.js.html @@ -111,13 +111,13 @@ module.exports = Runner
diff --git a/core_service-test-runner_service-tester.js.html b/core_service-test-runner_service-tester.js.html index b2051f8a9d..1c5212f5c5 100644 --- a/core_service-test-runner_service-tester.js.html +++ b/core_service-test-runner_service-tester.js.html @@ -179,13 +179,13 @@ module.exports = ServiceTester
diff --git a/core_service-test-runner_services-for-title.js.html b/core_service-test-runner_services-for-title.js.html index a86651b937..01c9d45f82 100644 --- a/core_service-test-runner_services-for-title.js.html +++ b/core_service-test-runner_services-for-title.js.html @@ -70,13 +70,13 @@ module.exports = servicesForTitle
diff --git a/core_token-pooling_token-pool.js.html b/core_token-pooling_token-pool.js.html index dde34a3fa9..1a12c3d490 100644 --- a/core_token-pooling_token-pool.js.html +++ b/core_token-pooling_token-pool.js.html @@ -397,13 +397,13 @@ module.exports = {
diff --git a/global.html b/global.html index 3e8a0e3aa7..f5858840da 100644 --- a/global.html +++ b/global.html @@ -104,6 +104,161 @@ +

isMetricWithPattern(nestedRegexp) → {function}

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
nestedRegexp + + +RegExp + + + +

Pattern that must appear after the metric.

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

A function that returns a RegExp that matches a metric followed by another pattern.

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

module:services/dynamic/json-path(superclass) → {function}

@@ -455,13 +610,13 @@
diff --git a/index.html b/index.html index 28427a8ce4..8f52587185 100644 --- a/index.html +++ b/index.html @@ -213,13 +213,13 @@ under their terms and license.


diff --git a/module-badge-maker.html b/module-badge-maker.html index 6188b4da92..69f9c1446f 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -381,13 +381,13 @@
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index 1913e96929..71a35092e4 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.


diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index 15f196c4ba..f9d1072eed 100644 --- a/module-badge-maker_lib_xml.html +++ b/module-badge-maker_lib_xml.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 96724b810e..bdfdfc3ca6 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


diff --git a/module-core_base-service_base-graphql-BaseGraphqlService.html b/module-core_base-service_base-graphql-BaseGraphqlService.html index 291b9c8e89..2f1b3b2cb5 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.


diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index 275aab1042..abb30098db 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-json-BaseJsonService.html b/module-core_base-service_base-json-BaseJsonService.html index 0e1f222d67..8d12a94607 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
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index c99fd7538d..baa7902089 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html index 50d1924d16..42d7da91ff 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
diff --git a/module-core_base-service_base-svg-scraping.html b/module-core_base-service_base-svg-scraping.html index 4abc3ad030..a63acd91cf 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-xml-BaseXmlService.html b/module-core_base-service_base-xml-BaseXmlService.html index 06eeb5dec2..7cf2b16c01 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
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 7733df9da1..b5b506e50c 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base-yaml-BaseYamlService.html b/module-core_base-service_base-yaml-BaseYamlService.html index 69c08f6d09..d58cbc24da 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
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index bd45bdc54b..1f4f74ab79 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -77,13 +77,13 @@
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index df51ca360e..04f1af6c3c 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,
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index af65f9da1a..764e4ed9fa 100644 --- a/module-core_base-service_errors-Deprecated.html +++ b/module-core_base-service_errors-Deprecated.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index affd5962a8..5e64c7a77c 100644 --- a/module-core_base-service_errors-ImproperlyConfigured.html +++ b/module-core_base-service_errors-ImproperlyConfigured.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index e70a97a8a0..be2c3c1617 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


diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index 7367d00d02..a68ef3e238 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


diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index c002285c72..0ff1e4c387 100644 --- a/module-core_base-service_errors-InvalidResponse.html +++ b/module-core_base-service_errors-InvalidResponse.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 2eea5392b1..624dd176d3 100644 --- a/module-core_base-service_errors-NotFound.html +++ b/module-core_base-service_errors-NotFound.html @@ -205,13 +205,13 @@
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 31872e2c66..1a2b7b7570 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.


diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 7fc52d558a..92785962df 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)


diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 2d1df2dc71..fe65602083 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.


diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index ed3a9f3fb7..5c99c16232 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()


diff --git a/module-core_server_server.html b/module-core_server_server.html index e10f5936cd..8d39cfcdf1 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -77,13 +77,13 @@
diff --git a/module-core_service-test-runner_create-service-tester.html b/module-core_service-test-runner_create-service-tester.html index 3e0d04765e..8dabfc2447 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.


diff --git a/module-core_service-test-runner_icedfrisby-shields.html b/module-core_service-test-runner_icedfrisby-shields.html index ddcf6471eb..8c234ed941 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -244,13 +244,13 @@
diff --git a/module-core_service-test-runner_infer-pull-request.html b/module-core_service-test-runner_infer-pull-request.html index ac90cb0935..834c83fe4f 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.


diff --git a/module-core_service-test-runner_runner-Runner.html b/module-core_service-test-runner_runner-Runner.html index ff64b55ac4..a43b176541 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.


diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index 24dd36d3e1..783363ef0c 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -77,13 +77,13 @@
diff --git a/module-core_service-test-runner_service-tester-ServiceTester.html b/module-core_service-test-runner_service-tester-ServiceTester.html index bbae1a038a..6568d02f3b 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.


diff --git a/module-core_service-test-runner_service-tester.html b/module-core_service-test-runner_service-tester.html index f34f62f883..0833343036 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -77,13 +77,13 @@
diff --git a/module-core_service-test-runner_services-for-title.html b/module-core_service-test-runner_services-for-title.html index f18ea1ac6e..2bdd80ddf0 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.


diff --git a/module-core_token-pooling_token-pool-Token.html b/module-core_token-pooling_token-pool-Token.html index 46b1d76999..0d32c83476 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.


diff --git a/module-core_token-pooling_token-pool-TokenPool.html b/module-core_token-pooling_token-pool-TokenPool.html index f3149f93d5..afb2ee7f66 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.


diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index d50266bf68..40cd85738b 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -243,13 +243,13 @@
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index 2832226d33..225bd79f95 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
diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index 0bc5c4b0cf..c6abdc8a0e 100644 --- a/module-services_steam_steam-base-BaseSteamAPI.html +++ b/module-services_steam_steam-base-BaseSteamAPI.html @@ -374,13 +374,13 @@
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index 011f8c7c59..3022bc2189 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -77,13 +77,13 @@
diff --git a/module.exports.html b/module.exports.html index 130e26c4f4..a8029e0308 100644 --- a/module.exports.html +++ b/module.exports.html @@ -628,13 +628,13 @@ Other keywords are possible, but will appear in grey.


diff --git a/services_criterion_criterion.service.js.html b/services_criterion_criterion.service.js.html index 3bfa69708a..46947012ec 100644 --- a/services_criterion_criterion.service.js.html +++ b/services_criterion_criterion.service.js.html @@ -104,13 +104,13 @@ module.exports = class Criterion extends BaseJsonService {
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index b405d3a645..bbe8d70b17 100644 --- a/services_dynamic_json-path.js.html +++ b/services_dynamic_json-path.js.html @@ -116,13 +116,13 @@ module.exports = superclass =>
diff --git a/services_github_github-total-star.service.js.html b/services_github_github-total-star.service.js.html index b1be575e92..c8e8488cd3 100644 --- a/services_github_github-total-star.service.js.html +++ b/services_github_github-total-star.service.js.html @@ -282,13 +282,13 @@ module.exports = class GithubTotalStarService extends GithubAuthV4Service {
diff --git a/services_osslifecycle_osslifecycle.service.js.html b/services_osslifecycle_osslifecycle.service.js.html index 4cc31c28d2..5b193c7c7a 100644 --- a/services_osslifecycle_osslifecycle.service.js.html +++ b/services_osslifecycle_osslifecycle.service.js.html @@ -135,13 +135,13 @@ module.exports = class OssTracker extends BaseService {
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index ae416bf27e..998d09634a 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -146,13 +146,13 @@ module.exports = {
diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 04a44fe92c..c850ef2a4a 100644 --- a/services_steam_steam-base.js.html +++ b/services_steam_steam-base.js.html @@ -93,13 +93,13 @@ module.exports = BaseSteamAPI
diff --git a/services_test-validators.js.html b/services_test-validators.js.html new file mode 100644 index 0000000000..e8a6c68d7d --- /dev/null +++ b/services_test-validators.js.html @@ -0,0 +1,232 @@ + + + + + JSDoc: Source: services/test-validators.js + + + + + + + + + + +
+ +

Source: services/test-validators.js

+ + + + + + +
+
+
'use strict'
+
+const Joi = require('joi')
+const { semver: isSemver } = require('./validators')
+
+/*
+  Note:
+  Validators defined in this file are used by more than one service.
+  Validators which are only used by one service
+  should be declared in that service's test file.
+*/
+
+const withRegex = re => Joi.string().regex(re)
+
+const isVPlusTripleDottedVersion = withRegex(/^v[0-9]+.[0-9]+.[0-9]+$/)
+
+const isVPlusDottedVersionAtLeastOne = withRegex(/^v\d+(\.\d+)?(\.\d+)?$/)
+
+// matches a version number with N 'clauses' e.g: v1.2 or v1.22.7.392 are valid
+const isVPlusDottedVersionNClauses = withRegex(/^v\d+(\.\d+)*$/)
+
+// matches a version number with N 'clauses'
+// and an optional text suffix
+// e.g: -beta, -preview1, -release-candidate, +beta, ~pre9-12 etc
+const isVPlusDottedVersionNClausesWithOptionalSuffix = withRegex(
+  /^v\d+(\.\d+)*([-+~].*)?$/
+)
+
+// same as above, but also accepts an optional 'epoch' prefix that can be
+// found e.g. in distro package versions, like 4:6.3.0-4
+const isVPlusDottedVersionNClausesWithOptionalSuffixAndEpoch = withRegex(
+  /^v(\d+:)?\d+(\.\d+)*([-+~].*)?$/
+)
+
+// Simple regex for test Composer versions rule
+// https://getcomposer.org/doc/articles/versions.md
+// Examples:
+// 7.1
+// >=5.6
+// >1.0 <2.0
+// !=1.0 <1.1 || >=1.2
+// 7.1.*
+// 7.* || 5.6.*
+// This regex not support branches, minimum-stability, ref and any (*)
+// https://getcomposer.org/doc/04-schema.md#package-links
+// https://getcomposer.org/doc/04-schema.md#minimum-stability
+const isComposerVersion = withRegex(
+  /^\s*(>=|>|<|<=|!=|\^|~)?\d+(\.(\*|(\d+(\.(\d+|\*))?)))?((\s*\|\|)?\s*(>=|>|<|<=|!=|\^|~)?\d+(\.(\*|(\d+(\.(\d+|\*))?)))?)*\s*$/
+)
+
+// Regex for validate php-version.versionReduction()
+// >= 7
+// >= 7.1
+// 5.4, 5.6, 7.2
+// 5.4 - 7.1, HHVM
+const isPhpVersionReduction = withRegex(
+  /^((>= \d+(\.\d+)?)|(\d+\.\d+(, \d+\.\d+)*)|(\d+\.\d+ - \d+\.\d+))(, HHVM)?$/
+)
+
+const isStarRating = withRegex(
+  /^(?=.{5}$)(\u2605{0,5}[\u00BC\u00BD\u00BE]?\u2606{0,5})$/
+)
+
+// Required to be > 0, because accepting zero masks many problems.
+const isMetric = withRegex(/^([1-9][0-9]*[kMGTPEZY]?|[1-9]\.[1-9][kMGTPEZY])$/)
+
+/**
+ * @param {RegExp} nestedRegexp Pattern that must appear after the metric.
+ * @returns {Function} A function that returns a RegExp that matches a metric followed by another pattern.
+ */
+const isMetricWithPattern = nestedRegexp => {
+  const pattern = `^([1-9][0-9]*[kMGTPEZY]?|[1-9]\\.[1-9][kMGTPEZY])${nestedRegexp.source}$`
+  const regexp = new RegExp(pattern)
+  return withRegex(regexp)
+}
+
+const isMetricOpenIssues = isMetricWithPattern(/ open/)
+
+const isMetricOverMetric = isMetricWithPattern(
+  /\/([1-9][0-9]*[kMGTPEZY]?|[1-9]\.[1-9][kMGTPEZY])/
+)
+
+const isMetricOverTimePeriod = isMetricWithPattern(
+  /\/(year|month|four weeks|quarter|week|day)/
+)
+
+const isZeroOverTimePeriod = withRegex(
+  /^0\/(year|month|four weeks|quarter|week|day)$/
+)
+
+const isIntegerPercentage = withRegex(/^[1-9][0-9]?%|^100%|^0%$/)
+const isDecimalPercentage = withRegex(/^[0-9]+\.[0-9]*%$/)
+const isPercentage = Joi.alternatives().try(
+  isIntegerPercentage,
+  isDecimalPercentage
+)
+
+const isFileSize = withRegex(/^[0-9]*[.]?[0-9]+\s(B|kB|MB|GB|TB|PB|EB|ZB|YB)$/)
+
+const isFormattedDate = Joi.alternatives().try(
+  Joi.equal('today', 'yesterday'),
+  Joi.string().regex(/^last (sun|mon|tues|wednes|thurs|fri|satur)day$/),
+  Joi.string().regex(
+    /^(january|february|march|april|may|june|july|august|september|october|november|december)( \d{4})?$/
+  )
+)
+
+const isRelativeFormattedDate = Joi.alternatives().try(
+  Joi.string().regex(
+    /^(in |)([0-9]+|a few|a|an|)(| )(second|minute|hour|day|month|year)(s|)( ago|)$/
+  )
+)
+
+const isDependencyState = withRegex(
+  /^(\d+ out of date|\d+ deprecated|up to date)$/
+)
+
+const makeTestTotalsValidator = ({ passed, failed, skipped }) =>
+  withRegex(
+    new RegExp(`^[0-9]+ ${passed}(, [0-9]+ ${failed})?(, [0-9]+ ${skipped})?$`)
+  )
+
+const makeCompactTestTotalsValidator = ({ passed, failed, skipped }) =>
+  withRegex(
+    new RegExp(
+      `^${passed} [0-9]+( \\| ${failed} [0-9]+)?( \\| ${skipped} [0-9]+)?$`
+    )
+  )
+
+const isDefaultTestTotals = makeTestTotalsValidator({
+  passed: 'passed',
+  failed: 'failed',
+  skipped: 'skipped',
+})
+const isDefaultCompactTestTotals = makeCompactTestTotalsValidator({
+  passed: '✔',
+  failed: '✘',
+  skipped: '➟',
+})
+const isCustomTestTotals = makeTestTotalsValidator({
+  passed: 'good',
+  failed: 'bad',
+  skipped: 'n/a',
+})
+const isCustomCompactTestTotals = makeCompactTestTotalsValidator({
+  passed: '💃',
+  failed: '🤦‍♀️',
+  skipped: '🤷',
+})
+
+module.exports = {
+  isSemver,
+  isVPlusTripleDottedVersion,
+  isVPlusDottedVersionAtLeastOne,
+  isVPlusDottedVersionNClauses,
+  isVPlusDottedVersionNClausesWithOptionalSuffix,
+  isVPlusDottedVersionNClausesWithOptionalSuffixAndEpoch,
+  isComposerVersion,
+  isPhpVersionReduction,
+  isStarRating,
+  isMetric,
+  isMetricWithPattern,
+  isMetricOpenIssues,
+  isMetricOverMetric,
+  isMetricOverTimePeriod,
+  isZeroOverTimePeriod,
+  isPercentage,
+  isIntegerPercentage,
+  isDecimalPercentage,
+  isFileSize,
+  isFormattedDate,
+  isRelativeFormattedDate,
+  isDependencyState,
+  withRegex,
+  isDefaultTestTotals,
+  isDefaultCompactTestTotals,
+  isCustomTestTotals,
+  isCustomCompactTestTotals,
+  makeTestTotalsValidator,
+  makeCompactTestTotalsValidator,
+}
+
+
+
+ + + + +
+ + + +
+ + + + + + + diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 63b1f038cc..105723a307 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -380,13 +380,13 @@ will review your contribution.
diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 398a3595a1..ba1274892d 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.
diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index a289f0252c..bc45473856 100644 --- a/tutorial-code-walkthrough.html +++ b/tutorial-code-walkthrough.html @@ -234,13 +234,13 @@ result over the HTTPS connection.
diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index 2b7d836608..4bbeedd363 100644 --- a/tutorial-deprecating-badges.html +++ b/tutorial-deprecating-badges.html @@ -110,13 +110,13 @@ t.create('no longer available (previously number of layers)')
diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index c682a0e9b5..2f2c2b1078 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -97,13 +97,13 @@
diff --git a/tutorial-json-format.html b/tutorial-json-format.html index eafdd80374..700f61417e 100644 --- a/tutorial-json-format.html +++ b/tutorial-json-format.html @@ -54,13 +54,13 @@ if you have any queries regarding the JSON format.


diff --git a/tutorial-logos.html b/tutorial-logos.html index 67a0d74935..40df76c664 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -90,13 +90,13 @@
diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index 14fbf66b63..6736f6ac63 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
diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index 50282721ef..4b654c6049 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -237,13 +237,13 @@ the server. It's generously donated by Sent
diff --git a/tutorial-releases.html b/tutorial-releases.html index c06523c795..1c81eef2b4 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -73,13 +73,13 @@
diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index e88a67a37a..d18590ae90 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -175,13 +175,13 @@ Set public.requireCloudflare: true.


diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index dc05d5e7a1..47cd3efdb5 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -231,13 +231,13 @@ and create an API key for the YouTube Data API v3.


diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index 0e7ecff4fa..f2098a283d 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -240,13 +240,13 @@ comment there instead.