From 04303cddef0f76da3f01dad157ca00001f26f313 Mon Sep 17 00:00:00 2001 From: "repo-ranger[bot]" Date: Mon, 15 Nov 2021 19:57:57 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20c7307?= =?UTF-8?q?2deed8eb6a5b9f51a06377f5f396ef21842=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 | 2 +- badge-maker_lib_xml.js.html | 2 +- core_base-service_base-graphql.js.html | 8 +++---- core_base-service_base-json.js.html | 8 +++---- core_base-service_base-svg-scraping.js.html | 8 +++---- core_base-service_base-xml.js.html | 8 +++---- core_base-service_base-yaml.js.html | 8 +++---- core_base-service_base.js.html | 21 ++++++++++-------- core_base-service_errors.js.html | 2 +- core_base-service_graphql.js.html | 2 +- core_legacy_regular-update.js.html | 2 +- core_server_prometheus-metrics.js.html | 2 +- core_server_server.js.html | 2 +- ...-test-runner_create-service-tester.js.html | 2 +- ...ice-test-runner_icedfrisby-shields.js.html | 2 +- ...ice-test-runner_infer-pull-request.js.html | 2 +- core_service-test-runner_runner.js.html | 2 +- ...service-test-runner_service-tester.js.html | 2 +- ...ice-test-runner_services-for-title.js.html | 2 +- core_token-pooling_token-pool.js.html | 2 +- global.html | 2 +- index.html | 2 +- module-badge-maker.html | 2 +- module-badge-maker_lib_xml-ElementList.html | 2 +- module-badge-maker_lib_xml-XmlElement.html | 2 +- module-badge-maker_lib_xml.html | 2 +- ...le-core_base-service_base-BaseService.html | 22 ++++++++++--------- ...rvice_base-graphql-BaseGraphqlService.html | 8 +++---- module-core_base-service_base-graphql.html | 2 +- ...ase-service_base-json-BaseJsonService.html | 8 +++---- module-core_base-service_base-json.html | 2 +- ...e-svg-scraping-BaseSvgScrapingService.html | 8 +++---- ...e-core_base-service_base-svg-scraping.html | 2 +- ..._base-service_base-xml-BaseXmlService.html | 8 +++---- module-core_base-service_base-xml.html | 2 +- ...ase-service_base-yaml-BaseYamlService.html | 8 +++---- module-core_base-service_base-yaml.html | 2 +- module-core_base-service_base.html | 12 +++++----- ...e-core_base-service_errors-Deprecated.html | 2 +- ...e-service_errors-ImproperlyConfigured.html | 2 +- ...core_base-service_errors-Inaccessible.html | 2 +- ..._base-service_errors-InvalidParameter.html | 2 +- ...e_base-service_errors-InvalidResponse.html | 2 +- module-core_base-service_errors-NotFound.html | 2 +- ...se-service_errors-ShieldsRuntimeError.html | 2 +- module-core_base-service_errors.html | 2 +- module-core_base-service_graphql.html | 2 +- module-core_legacy_regular-update.html | 2 +- module-core_server_server-Server.html | 2 +- module-core_server_server.html | 2 +- ...ice-test-runner_create-service-tester.html | 2 +- ...ervice-test-runner_icedfrisby-shields.html | 2 +- ...ervice-test-runner_infer-pull-request.html | 2 +- ...ore_service-test-runner_runner-Runner.html | 2 +- module-core_service-test-runner_runner.html | 2 +- ...t-runner_service-tester-ServiceTester.html | 2 +- ...re_service-test-runner_service-tester.html | 2 +- ...ervice-test-runner_services-for-title.html | 2 +- ...e-core_token-pooling_token-pool-Token.html | 2 +- ...re_token-pooling_token-pool-TokenPool.html | 2 +- module-core_token-pooling_token-pool.html | 2 +- module-services_downloads.html | 2 +- module-services_dynamic_json-path.html | 2 +- ...ervices_steam_steam-base-BaseSteamAPI.html | 2 +- module-services_steam_steam-base.html | 2 +- services_downloads.js.html | 2 +- services_dynamic_json-path.js.html | 2 +- services_packagist_packagist-base.js.html | 2 +- services_steam_steam-base.js.html | 2 +- services_test-validators.js.html | 2 +- tutorial-TUTORIAL.html | 6 ++--- tutorial-adding-new-config-values.html | 2 +- tutorial-badge-urls.html | 2 +- tutorial-code-walkthrough.html | 2 +- tutorial-deprecating-badges.html | 2 +- tutorial-input-validation.html | 2 +- tutorial-json-format.html | 2 +- tutorial-logos.html | 2 +- tutorial-performance-testing.html | 2 +- tutorial-production-hosting.html | 2 +- tutorial-releases.html | 2 +- tutorial-self-hosting.html | 2 +- tutorial-server-secrets.html | 2 +- tutorial-service-tests.html | 2 +- 84 files changed, 143 insertions(+), 138 deletions(-) diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index c6904b5025..ed1b7303cf 100644 --- a/badge-maker_lib_index.js.html +++ b/badge-maker_lib_index.js.html @@ -123,7 +123,7 @@ module.exports = {
diff --git a/badge-maker_lib_xml.js.html b/badge-maker_lib_xml.js.html index b2edc7187b..1d3615e711 100644 --- a/badge-maker_lib_xml.js.html +++ b/badge-maker_lib_xml.js.html @@ -138,7 +138,7 @@ 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 bfdd2aab58..66db18d43f 100644 --- a/core_base-service_base-graphql.js.html +++ b/core_base-service_base-graphql.js.html @@ -66,8 +66,8 @@ class BaseGraphqlService extends BaseService { * representing the query clause of GraphQL POST body * e.g. gql`{ query { ... } }` * @param {object} attrs.variables Variables clause of GraphQL POST body - * @param {object} [attrs.options={}] Options to pass to request. See - * [documentation](https://github.com/request/request#requestoptions-callback) + * @param {object} [attrs.options={}] Options to pass to got. See + * [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) * @param {object} [attrs.httpErrorMessages={}] Key-value map of HTTP status codes * and custom error messages e.g: `{ 404: 'package not found' }`. * This can be used to extend or override the @@ -81,7 +81,7 @@ class BaseGraphqlService extends BaseService { * The default is to return the first entry of the `errors` array as * an InvalidResponse. * @returns {object} Parsed response - * @see https://github.com/request/request#requestoptions-callback + * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md */ async _requestGraphql({ schema, @@ -136,7 +136,7 @@ export default BaseGraphqlService
diff --git a/core_base-service_base-json.js.html b/core_base-service_base-json.js.html index c1feaabce3..4be4d46cd9 100644 --- a/core_base-service_base-json.js.html +++ b/core_base-service_base-json.js.html @@ -56,14 +56,14 @@ class BaseJsonService extends BaseService { * @param {object} attrs Refer to individual attrs * @param {Joi} attrs.schema Joi schema to validate the response against * @param {string} attrs.url URL to request - * @param {object} [attrs.options={}] Options to pass to request. See - * [documentation](https://github.com/request/request#requestoptions-callback) + * @param {object} [attrs.options={}] Options to pass to got. See + * [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) * @param {object} [attrs.errorMessages={}] Key-value map of status codes * and custom error messages e.g: `{ 404: 'package not found' }`. * This can be used to extend or override the * [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5) * @returns {object} Parsed response - * @see https://github.com/request/request#requestoptions-callback + * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md */ async _requestJson({ schema, url, options = {}, errorMessages = {} }) { const mergedOptions = { @@ -97,7 +97,7 @@ export default BaseJsonService
diff --git a/core_base-service_base-svg-scraping.js.html b/core_base-service_base-svg-scraping.js.html index 12148a7456..7793f053bb 100644 --- a/core_base-service_base-svg-scraping.js.html +++ b/core_base-service_base-svg-scraping.js.html @@ -79,14 +79,14 @@ class BaseSvgScrapingService extends BaseService { * @param {RegExp} attrs.valueMatcher * RegExp to match the value we want to parse from the SVG * @param {string} attrs.url URL to request - * @param {object} [attrs.options={}] Options to pass to request. See - * [documentation](https://github.com/request/request#requestoptions-callback) + * @param {object} [attrs.options={}] Options to pass to got. See + * [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) * @param {object} [attrs.errorMessages={}] Key-value map of status codes * and custom error messages e.g: `{ 404: 'package not found' }`. * This can be used to extend or override the * [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5) * @returns {object} Parsed response - * @see https://github.com/request/request#requestoptions-callback + * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md */ async _requestSvg({ schema, @@ -133,7 +133,7 @@ export default BaseSvgScrapingService
diff --git a/core_base-service_base-xml.js.html b/core_base-service_base-xml.js.html index 01e107c1ae..35f1f85764 100644 --- a/core_base-service_base-xml.js.html +++ b/core_base-service_base-xml.js.html @@ -50,8 +50,8 @@ class BaseXmlService extends BaseService { * @param {object} attrs Refer to individual attrs * @param {Joi} attrs.schema Joi schema to validate the response against * @param {string} attrs.url URL to request - * @param {object} [attrs.options={}] Options to pass to request. See - * [documentation](https://github.com/request/request#requestoptions-callback) + * @param {object} [attrs.options={}] Options to pass to got. See + * [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) * @param {object} [attrs.errorMessages={}] Key-value map of status codes * and custom error messages e.g: `{ 404: 'package not found' }`. * This can be used to extend or override the @@ -59,7 +59,7 @@ class BaseXmlService extends BaseService { * @param {object} [attrs.parserOptions={}] Options to pass to fast-xml-parser. See * [documentation](https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json) * @returns {object} Parsed response - * @see https://github.com/request/request#requestoptions-callback + * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md * @see https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json */ async _requestXml({ @@ -111,7 +111,7 @@ export default BaseXmlService
diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index b4150d62c6..a1afea4db0 100644 --- a/core_base-service_base-yaml.js.html +++ b/core_base-service_base-yaml.js.html @@ -49,15 +49,15 @@ class BaseYamlService extends BaseService { * @param {object} attrs Refer to individual attrs * @param {Joi} attrs.schema Joi schema to validate the response against * @param {string} attrs.url URL to request - * @param {object} [attrs.options={}] Options to pass to request. See - * [documentation](https://github.com/request/request#requestoptions-callback) + * @param {object} [attrs.options={}] Options to pass to got. See + * [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) * @param {object} [attrs.errorMessages={}] Key-value map of status codes * and custom error messages e.g: `{ 404: 'package not found' }`. * This can be used to extend or override the * [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5) * @param {object} [attrs.encoding='utf8'] Character encoding * @returns {object} Parsed response - * @see https://github.com/request/request#requestoptions-callback + * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md */ async _requestYaml({ schema, @@ -115,7 +115,7 @@ export default BaseYamlService
diff --git a/core_base-service_base.js.html b/core_base-service_base.js.html index cc8f14fea5..7796a6aded 100644 --- a/core_base-service_base.js.html +++ b/core_base-service_base.js.html @@ -136,11 +136,14 @@ class BaseService { * * See also the config schema in `./server.js` and `doc/server-secrets.md`. * - * To use the configured auth in the handler or fetch method, pass the - * credentials to the request. For example: - * - `{ options: { auth: this.authHelper.basicAuth } }` - * - `{ options: { headers: this.authHelper.bearerAuthHeader } }` - * - `{ options: { qs: { token: this.authHelper._pass } } }` + * To use the configured auth in the handler or fetch method, wrap the + * _request() input params in a call to one of: + * - this.authHelper.withBasicAuth() + * - this.authHelper.withBearerAuthHeader() + * - this.authHelper.withQueryStringAuth() + * + * For example: + * this._request(this.authHelper.withBasicAuth({ url, schema, options })) * * @abstract * @type {module:core/base-service/base~Auth} @@ -245,10 +248,10 @@ class BaseService { const logTrace = (...args) => trace.logTrace('fetch', ...args) let logUrl = url const logOptions = Object.assign({}, options) - if ('qs' in options) { - const params = new URLSearchParams(options.qs) + if ('searchParams' in options) { + const params = new URLSearchParams(options.searchParams) logUrl = `${url}?${params.toString()}` - delete logOptions.qs + delete logOptions.searchParams } logTrace( emojic.bowAndArrow, @@ -617,7 +620,7 @@ export default BaseService
diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index 512a30fba0..5cde60f415 100644 --- a/core_base-service_errors.js.html +++ b/core_base-service_errors.js.html @@ -261,7 +261,7 @@ export {
diff --git a/core_base-service_graphql.js.html b/core_base-service_graphql.js.html index a5ffab7196..6599d8b27b 100644 --- a/core_base-service_graphql.js.html +++ b/core_base-service_graphql.js.html @@ -93,7 +93,7 @@ export { mergeQueries }
diff --git a/core_legacy_regular-update.js.html b/core_legacy_regular-update.js.html index d15e77dfd8..cb55945b07 100644 --- a/core_legacy_regular-update.js.html +++ b/core_legacy_regular-update.js.html @@ -108,7 +108,7 @@ export { regularUpdate, clearRegularUpdateCache }
diff --git a/core_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index 83c0a539ef..0bf3765382 100644 --- a/core_server_prometheus-metrics.js.html +++ b/core_server_prometheus-metrics.js.html @@ -127,7 +127,7 @@ export default class PrometheusMetrics {
diff --git a/core_server_server.js.html b/core_server_server.js.html index 395f9a530f..36f4e2b0d7 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -612,7 +612,7 @@ 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 99b0453c7e..00286ebb3b 100644 --- a/core_service-test-runner_create-service-tester.js.html +++ b/core_service-test-runner_create-service-tester.js.html @@ -74,7 +74,7 @@ export default createServiceTester
diff --git a/core_service-test-runner_icedfrisby-shields.js.html b/core_service-test-runner_icedfrisby-shields.js.html index d70bd79f96..b5a0fccd02 100644 --- a/core_service-test-runner_icedfrisby-shields.js.html +++ b/core_service-test-runner_icedfrisby-shields.js.html @@ -131,7 +131,7 @@ 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 e8998140b5..d7762739e2 100644 --- a/core_service-test-runner_infer-pull-request.js.html +++ b/core_service-test-runner_infer-pull-request.js.html @@ -142,7 +142,7 @@ export { parseGithubPullRequestUrl, parseGithubRepoSlug, inferPullRequest }
diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index 99ad281668..8fcb33dee1 100644 --- a/core_service-test-runner_runner.js.html +++ b/core_service-test-runner_runner.js.html @@ -118,7 +118,7 @@ export default Runner
diff --git a/core_service-test-runner_service-tester.js.html b/core_service-test-runner_service-tester.js.html index fcfb1d712b..1ab4f1591d 100644 --- a/core_service-test-runner_service-tester.js.html +++ b/core_service-test-runner_service-tester.js.html @@ -184,7 +184,7 @@ 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 fbf4c74a20..4558c5cec7 100644 --- a/core_service-test-runner_services-for-title.js.html +++ b/core_service-test-runner_services-for-title.js.html @@ -75,7 +75,7 @@ export default servicesForTitle
diff --git a/core_token-pooling_token-pool.js.html b/core_token-pooling_token-pool.js.html index adf91c29cc..8adc45a8f3 100644 --- a/core_token-pooling_token-pool.js.html +++ b/core_token-pooling_token-pool.js.html @@ -379,7 +379,7 @@ export { sanitizeToken, Token, TokenPool }
diff --git a/global.html b/global.html index ba6519d531..e230c4ffb3 100644 --- a/global.html +++ b/global.html @@ -684,7 +684,7 @@
diff --git a/index.html b/index.html index bc88844387..ec76580a3d 100644 --- a/index.html +++ b/index.html @@ -223,7 +223,7 @@ under their terms and license.


diff --git a/module-badge-maker.html b/module-badge-maker.html index ca46eb175f..d61b1e3424 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -387,7 +387,7 @@
diff --git a/module-badge-maker_lib_xml-ElementList.html b/module-badge-maker_lib_xml-ElementList.html index 8527e8bde8..0a2c6bbcdf 100644 --- a/module-badge-maker_lib_xml-ElementList.html +++ b/module-badge-maker_lib_xml-ElementList.html @@ -163,7 +163,7 @@ like an XmlElement but renders multiple XML tags (not wrapped in a ).

- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index d8d25ec1f7..02cf962f04 100644 --- a/module-badge-maker_lib_xml-XmlElement.html +++ b/module-badge-maker_lib_xml-XmlElement.html @@ -474,7 +474,7 @@ element will be rendered as a self-closing element.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index dfb9da6ec6..f9d20faee7 100644 --- a/module-badge-maker_lib_xml.html +++ b/module-badge-maker_lib_xml.html @@ -86,7 +86,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 914810c32d..01bdc8af9b 100644 --- a/module-core_base-service_base-BaseService.html +++ b/module-core_base-service_base-BaseService.html @@ -300,13 +300,15 @@ the badges on the main shields.io website.

Configuration for the authentication helper that prepares credentials for upstream requests.

See also the config schema in ./server.js and doc/server-secrets.md.

-

To use the configured auth in the handler or fetch method, pass the -credentials to the request. For example:

+

To use the configured auth in the handler or fetch method, wrap the +_request() input params in a call to one of:

+

For example: +this._request(this.authHelper.withBasicAuth({ url, schema, options }))

@@ -354,7 +356,7 @@ credentials to the request. For example:

Source:
@@ -428,7 +430,7 @@ from the handler nor overridden by the user via query parameters.

Source:
@@ -507,7 +509,7 @@ part of the example.

Source:
@@ -669,7 +671,7 @@ defined in this.route.pattern or this.route.capture

Source:
@@ -743,7 +745,7 @@ defined in this.route.pattern or this.route.capture


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 77abde56fe..57b8f47bf8 100644 --- a/module-core_base-service_base-graphql-BaseGraphqlService.html +++ b/module-core_base-service_base-graphql-BaseGraphqlService.html @@ -574,8 +574,8 @@ e.g. gql{ query { ... } }

-

Options to pass to request. See -documentation

+

Options to pass to got. See +documentation

@@ -758,7 +758,7 @@ an InvalidResponse.

See:
@@ -829,7 +829,7 @@ an InvalidResponse.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index a63b6b1479..1dbbebbfef 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 45d301326b..3c6373785e 100644 --- a/module-core_base-service_base-json-BaseJsonService.html +++ b/module-core_base-service_base-json-BaseJsonService.html @@ -502,8 +502,8 @@ parse it and validate against a schema

-

Options to pass to request. See -documentation

+

Options to pass to got. See +documentation

@@ -603,7 +603,7 @@ This can be used to extend or override the
See:
@@ -674,7 +674,7 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 1185ee252b..a6a23528d5 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 4edb6dcd8d..fab376799b 100644 --- a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html +++ b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html @@ -593,8 +593,8 @@ parse a value from it and validate against a schema

-

Options to pass to request. See -documentation

+

Options to pass to got. See +documentation

@@ -694,7 +694,7 @@ This can be used to extend or override the
See:
@@ -765,7 +765,7 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 dc18e948c9..1f6b0ae9b4 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 48661e27c7..f3804251b6 100644 --- a/module-core_base-service_base-xml-BaseXmlService.html +++ b/module-core_base-service_base-xml-BaseXmlService.html @@ -343,8 +343,8 @@ parse it and validate against a schema

-

Options to pass to request. See -documentation

+

Options to pass to got. See +documentation

@@ -484,7 +484,7 @@ This can be used to extend or override the
See:
@@ -557,7 +557,7 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 84acd5f5a2..00aee2380e 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 0c940eeeab..2e962c02c4 100644 --- a/module-core_base-service_base-yaml-BaseYamlService.html +++ b/module-core_base-service_base-yaml-BaseYamlService.html @@ -343,8 +343,8 @@ parse it and validate against a schema

-

Options to pass to request. See -documentation

+

Options to pass to got. See +documentation

@@ -483,7 +483,7 @@ This can be used to extend or override the
See:
@@ -554,7 +554,7 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index b0836a3d21..ff9dd4b80a 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index 5b09a3fa0b..68ace1818e 100644 --- a/module-core_base-service_base.html +++ b/module-core_base-service_base.html @@ -219,7 +219,7 @@ configured credentials are present.

Source:
@@ -438,7 +438,7 @@ configured credentials are present.

Source:
@@ -631,7 +631,7 @@ configured credentials are present.

Source:
@@ -897,7 +897,7 @@ users locate relevant badges.

Source:
@@ -1130,7 +1130,7 @@ when the parameter is absent. (Note that in,
Source:
@@ -1166,7 +1166,7 @@ when the parameter is absent. (Note that in,
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index fa0f454cae..e01455b373 100644 --- a/module-core_base-service_errors-Deprecated.html +++ b/module-core_base-service_errors-Deprecated.html @@ -211,7 +211,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index eb49418c7c..a4881ef432 100644 --- a/module-core_base-service_errors-ImproperlyConfigured.html +++ b/module-core_base-service_errors-ImproperlyConfigured.html @@ -211,7 +211,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index 98f6b44949..fbdf81c51a 100644 --- a/module-core_base-service_errors-Inaccessible.html +++ b/module-core_base-service_errors-Inaccessible.html @@ -212,7 +212,7 @@ or to wrap a 5XX response


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index bd4fb1f76c..1380ea38a6 100644 --- a/module-core_base-service_errors-InvalidParameter.html +++ b/module-core_base-service_errors-InvalidParameter.html @@ -212,7 +212,7 @@ is invalid or unexpected


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index 2c00915c6b..cee64c80c9 100644 --- a/module-core_base-service_errors-InvalidResponse.html +++ b/module-core_base-service_errors-InvalidResponse.html @@ -211,7 +211,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 77e6d7735d..2f7e48dc3e 100644 --- a/module-core_base-service_errors-NotFound.html +++ b/module-core_base-service_errors-NotFound.html @@ -211,7 +211,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 570bb7a3e6..f771f075d6 100644 --- a/module-core_base-service_errors-ShieldsRuntimeError.html +++ b/module-core_base-service_errors-ShieldsRuntimeError.html @@ -384,7 +384,7 @@ should override this method.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 9254c31248..b1f64d5538 100644 --- a/module-core_base-service_errors.html +++ b/module-core_base-service_errors.html @@ -354,7 +354,7 @@ badge when we catch and render the exception (Optional)


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 890d0cd940..1a5c386ef3 100644 --- a/module-core_base-service_graphql.html +++ b/module-core_base-service_graphql.html @@ -254,7 +254,7 @@ but can't use that due to incorrect packaging.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_legacy_regular-update.html b/module-core_legacy_regular-update.html index e2bfbe0f1c..7cf7f38d65 100644 --- a/module-core_legacy_regular-update.html +++ b/module-core_legacy_regular-update.html @@ -495,7 +495,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index 328ac9b1df..ab6d75e2b7 100644 --- a/module-core_server_server-Server.html +++ b/module-core_server_server-Server.html @@ -681,7 +681,7 @@ Start listening for requests on this.baseUrl()


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_server_server.html b/module-core_server_server.html index f447001ef6..00e307eade 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 088e617b3b..7c633d73b1 100644 --- a/module-core_service-test-runner_create-service-tester.html +++ b/module-core_service-test-runner_create-service-tester.html @@ -194,7 +194,7 @@ service.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 8f8d56ac59..d29947239f 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -250,7 +250,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 682f029aca..0a5d225db2 100644 --- a/module-core_service-test-runner_infer-pull-request.html +++ b/module-core_service-test-runner_infer-pull-request.html @@ -470,7 +470,7 @@ of a pull request from the environment variables.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 8732bccce3..9cc33419d0 100644 --- a/module-core_service-test-runner_runner-Runner.html +++ b/module-core_service-test-runner_runner-Runner.html @@ -568,7 +568,7 @@ overridden on instances.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index 8d0f54851f..8c18144d4c 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 a24f7be670..ffe2beae5f 100644 --- a/module-core_service-test-runner_service-tester-ServiceTester.html +++ b/module-core_service-test-runner_service-tester-ServiceTester.html @@ -1126,7 +1126,7 @@ the CLI, or directly on the tester.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 3a735c7b97..722e25b98d 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 5e853cda5c..23e1d32615 100644 --- a/module-core_service-test-runner_services-for-title.html +++ b/module-core_service-test-runner_services-for-title.html @@ -242,7 +242,7 @@ as an array of strings.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 88434f6412..ea9434517d 100644 --- a/module-core_token-pooling_token-pool-Token.html +++ b/module-core_token-pooling_token-pool-Token.html @@ -715,7 +715,7 @@ stable ordering for a valid priority queue.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 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 8013bc1434..bd9b5dc457 100644 --- a/module-core_token-pooling_token-pool-TokenPool.html +++ b/module-core_token-pooling_token-pool-TokenPool.html @@ -899,7 +899,7 @@ indicate it should not be reused.


- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index a0480047a2..9ba8b16c27 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -249,7 +249,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_downloads.html b/module-services_downloads.html index 70f4f94cb6..e139b4f0a4 100644 --- a/module-services_downloads.html +++ b/module-services_downloads.html @@ -504,7 +504,7 @@ this value as the prefix for versioned badges, e.g. foobar@v1.23. D
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index a485b09e9c..834cdad160 100644 --- a/module-services_dynamic_json-path.html +++ b/module-services_dynamic_json-path.html @@ -542,7 +542,7 @@ This can be used to extend or override the
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index 3d55dd64e9..d550fb18bb 100644 --- a/module-services_steam_steam-base-BaseSteamAPI.html +++ b/module-services_steam_steam-base-BaseSteamAPI.html @@ -380,7 +380,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index 2fc106a75b..9ce09d90ca 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -83,7 +83,7 @@
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/services_downloads.js.html b/services_downloads.js.html index 727ad14583..d34c73a24a 100644 --- a/services_downloads.js.html +++ b/services_downloads.js.html @@ -101,7 +101,7 @@ export { renderDownloadsBadge }
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index 62c29e9062..3ea7f450e1 100644 --- a/services_dynamic_json-path.js.html +++ b/services_dynamic_json-path.js.html @@ -120,7 +120,7 @@ export default superclass =>
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index c26e2804cf..e950e12589 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -150,7 +150,7 @@ export {
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 2d0c908b3b..935bc82d5a 100644 --- a/services_steam_steam-base.js.html +++ b/services_steam_steam-base.js.html @@ -98,7 +98,7 @@ export default BaseSteamAPI
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/services_test-validators.js.html b/services_test-validators.js.html index 2a6609f61f..dcac2d0f00 100644 --- a/services_test-validators.js.html +++ b/services_test-validators.js.html @@ -223,7 +223,7 @@ export {
- Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.7 on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time)
diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 0741637fc6..4785220e01 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -260,12 +260,12 @@ export default class GemVersion extends BaseJsonService {

Working our way upward, the async fetch() method is responsible for calling an API endpoint to get data. Extending BaseJsonService gives us the helper function _requestJson(). Note here that we pass the schema we defined in step 4 as an argument. _requestJson() will deal with validating the response against the schema and throwing an error if necessary.