diff --git a/badge-maker_lib_index.js.html b/badge-maker_lib_index.js.html index c6904b5025fc42d2b5680e7b0cc5827e1f15a068..ed1b7303cfd391e17b4ff9a3f6c899f495ddd15f 100644 --- a/badge-maker_lib_index.js.html +++ b/badge-maker_lib_index.js.html @@ -123,7 +123,7 @@ module.exports = { <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/badge-maker_lib_xml.js.html b/badge-maker_lib_xml.js.html index b2edc7187b35c536befdb49d4620acb6ecf6c09f..1d3615e7118a74fbe5055d56af83d35e03323816 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 } <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_base-graphql.js.html b/core_base-service_base-graphql.js.html index bfdd2aab58999b13db6584809d26f6087e3d85a9..66db18d43ff51c075042f3e8a6ed937d832245e4 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_base-json.js.html b/core_base-service_base-json.js.html index c1feaabce393f93d8b06c0ea3aec7bcc469ea049..4be4d46cd932e54940bf1016078a12d342c1a8e9 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_base-svg-scraping.js.html b/core_base-service_base-svg-scraping.js.html index 12148a7456f31b1d38fc774e64e69325f45ce9a7..7793f053bbc1a5404371091bd29eae0934d375b5 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_base-xml.js.html b/core_base-service_base-xml.js.html index 01e107c1ae589c9885f79b6534c865a6649f6df0..35f1f857648f9ddd0896eac30d22d51a6fd58365 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_base-yaml.js.html b/core_base-service_base-yaml.js.html index b4150d62c6e6c05578de6e3b4cbaeb1728df9822..a1afea4db0a79dbb63b280f5e65c290c9d71c4c8 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_base.js.html b/core_base-service_base.js.html index cc8f14fea5ef2b1820e739a7ea616df165902c3a..7796a6adede1f3bed48072a4a107a3056e178fa6 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_errors.js.html b/core_base-service_errors.js.html index 512a30fba0cbf8832e9c7a1ce11c25fb5004c5e5..5cde60f4158944bc9a7c7c16ae246f05d8858ded 100644 --- a/core_base-service_errors.js.html +++ b/core_base-service_errors.js.html @@ -261,7 +261,7 @@ export { <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_base-service_graphql.js.html b/core_base-service_graphql.js.html index a5ffab7196359202f700eb957589ad79a9542890..6599d8b27bb690794baa89b32a58494068b35e11 100644 --- a/core_base-service_graphql.js.html +++ b/core_base-service_graphql.js.html @@ -93,7 +93,7 @@ export { mergeQueries } <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_legacy_regular-update.js.html b/core_legacy_regular-update.js.html index d15e77dfd84ab9254045ecfafa59ac7f0096778c..cb55945b07a8dbefcad4211f262820deaed08079 100644 --- a/core_legacy_regular-update.js.html +++ b/core_legacy_regular-update.js.html @@ -108,7 +108,7 @@ export { regularUpdate, clearRegularUpdateCache } <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_server_prometheus-metrics.js.html b/core_server_prometheus-metrics.js.html index 83c0a539ef5458e92f7ea9b89b30a510db169353..0bf3765382538333fd63f109666603b7395efc80 100644 --- a/core_server_prometheus-metrics.js.html +++ b/core_server_prometheus-metrics.js.html @@ -127,7 +127,7 @@ export default class PrometheusMetrics { <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_server_server.js.html b/core_server_server.js.html index 395f9a530f7392273b9b7a52784259787ef51b0e..36f4e2b0d77ba28c7a15b891c6d4b95aad4727cb 100644 --- a/core_server_server.js.html +++ b/core_server_server.js.html @@ -612,7 +612,7 @@ export default Server <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_service-test-runner_create-service-tester.js.html b/core_service-test-runner_create-service-tester.js.html index 99b0453c7e947bd2bd6db4c7ff320d905bbf97ae..00286ebb3bfc58a223f9ae8b8a8479f2d59a1a7a 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_service-test-runner_icedfrisby-shields.js.html b/core_service-test-runner_icedfrisby-shields.js.html index d70bd79f96b0d4e7779adc36bc4ec2b01d3b64f7..b5a0fccd02051e711a71c29aa0c7545cf1f1b7a5 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_service-test-runner_infer-pull-request.js.html b/core_service-test-runner_infer-pull-request.js.html index e8998140b5f3eb894e3912d40dc2d6bf9dc0c512..d7762739e2ee54cd7648eb06780eaacb56a6d1db 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 } <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_service-test-runner_runner.js.html b/core_service-test-runner_runner.js.html index 99ad281668b6ce599156bd0ed8fa0d7fa293f9a5..8fcb33dee1071a722e5681390d72f983c191889a 100644 --- a/core_service-test-runner_runner.js.html +++ b/core_service-test-runner_runner.js.html @@ -118,7 +118,7 @@ export default Runner <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_service-test-runner_service-tester.js.html b/core_service-test-runner_service-tester.js.html index fcfb1d712bd5505182e8709318a054d560049077..1ab4f1591d8c96c894a04bc7c179a9ceea467253 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_service-test-runner_services-for-title.js.html b/core_service-test-runner_services-for-title.js.html index fbf4c74a2065873623ce605b817e49fe6cd57bbe..4558c5cec750f02f12619ac7516806c6a47331fd 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/core_token-pooling_token-pool.js.html b/core_token-pooling_token-pool.js.html index adf91c29cc15296d017cd25ed4f9759d518409b8..8adc45a8f3f84beba91e7b16a5b7cf444d1e74be 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 } <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/global.html b/global.html index ba6519d531628389845a5e1cf07f69177a54ade2..e230c4ffb36720cd92f1d6b19ba0deeab5080a46 100644 --- a/global.html +++ b/global.html @@ -684,7 +684,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/index.html b/index.html index bc8884438748f8e645ea2e05dac9a4f14dbf8fb6..ec76580a3d571fda14bbcec5cd59f5dfe2cda4be 100644 --- a/index.html +++ b/index.html @@ -223,7 +223,7 @@ under their terms and license.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-badge-maker.html b/module-badge-maker.html index ca46eb175fd1c23da6954ab451ed7a44d7959060..d61b1e3424266d9e7050004147b2aab72ba3d852 100644 --- a/module-badge-maker.html +++ b/module-badge-maker.html @@ -387,7 +387,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-badge-maker_lib_xml-ElementList.html b/module-badge-maker_lib_xml-ElementList.html index 8527e8bde8ad2732648f752bbb697a003815fa33..0a2c6bbcdf65de98e57f1cf7d2065ce832a401b9 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 <g>).</p></di <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-badge-maker_lib_xml-XmlElement.html b/module-badge-maker_lib_xml-XmlElement.html index d8d25ec1f757cc50839855211cb1434835015e09..02cf962f04a7b2cb514c15cba1fffe5e6dc7f3b5 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.</p></td> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-badge-maker_lib_xml.html b/module-badge-maker_lib_xml.html index dfb9da6ec6fa207d7a594587aae8f45994f180c6..f9d20faee7bcb96d7f9bf0f81395bdaff259da93 100644 --- a/module-badge-maker_lib_xml.html +++ b/module-badge-maker_lib_xml.html @@ -86,7 +86,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-BaseService.html b/module-core_base-service_base-BaseService.html index 914810c32da8d49c37d4a497fbf03c976b42166a..01bdc8af9b8af04a0929eeaace0bc6df239a8f8d 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.</p> <p>Configuration for the authentication helper that prepares credentials for upstream requests.</p> <p>See also the config schema in <code>./server.js</code> and <code>doc/server-secrets.md</code>.</p> -<p>To use the configured auth in the handler or fetch method, pass the -credentials to the request. For example:</p> +<p>To use the configured auth in the handler or fetch method, wrap the +_request() input params in a call to one of:</p> <ul> -<li><code>{ options: { auth: this.authHelper.basicAuth } }</code></li> -<li><code>{ options: { headers: this.authHelper.bearerAuthHeader } }</code></li> -<li><code>{ options: { qs: { token: this.authHelper._pass } } }</code></li> +<li>this.authHelper.withBasicAuth()</li> +<li>this.authHelper.withBearerAuthHeader()</li> +<li>this.authHelper.withQueryStringAuth()</li> </ul> +<p>For example: +this._request(this.authHelper.withBasicAuth({ url, schema, options }))</p> </div> @@ -354,7 +356,7 @@ credentials to the request. For example:</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line120">line 120</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line123">line 123</a> </li></ul></dd> @@ -428,7 +430,7 @@ from the handler nor overridden by the user via query parameters.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line159">line 159</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line162">line 162</a> </li></ul></dd> @@ -507,7 +509,7 @@ part of the example.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line138">line 138</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line141">line 141</a> </li></ul></dd> @@ -669,7 +671,7 @@ defined in this.route.pattern or this.route.capture</p></td> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line287">line 287</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line290">line 290</a> </li></ul></dd> @@ -743,7 +745,7 @@ defined in this.route.pattern or this.route.capture</p></td> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-graphql-BaseGraphqlService.html b/module-core_base-service_base-graphql-BaseGraphqlService.html index 77abde56fe41cc4c4db33848c672b887fa3e98e5..57b8f47bf890f27ef41fa854381a92b5a07bc3e7 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<code>{ query { ... } }</code></p></td> </td> - <td class="description last"><p>Options to pass to request. See -<a href="https://github.com/request/request#requestoptions-callback">documentation</a></p></td> + <td class="description last"><p>Options to pass to got. See +<a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">documentation</a></p></td> </tr> @@ -758,7 +758,7 @@ an InvalidResponse.</p></td> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> - <li><a href="https://github.com/request/request#requestoptions-callback">https://github.com/request/request#requestoptions-callback</a></li> + <li><a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">https://github.com/sindresorhus/got/blob/main/documentation/2-options.md</a></li> </ul> </dd> @@ -829,7 +829,7 @@ an InvalidResponse.</p></td> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-graphql.html b/module-core_base-service_base-graphql.html index a63b6b1479d8295bad740b7c750941be4c09dd1a..1dbbebbfef48141a4f20292f45df7c81ce36ea09 100644 --- a/module-core_base-service_base-graphql.html +++ b/module-core_base-service_base-graphql.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-json-BaseJsonService.html b/module-core_base-service_base-json-BaseJsonService.html index 45d301326b63ccf906dadac31a58c4cddfcaea32..3c6373785e150d6f06dc31de49328e907b207aea 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</p> </td> - <td class="description last"><p>Options to pass to request. See -<a href="https://github.com/request/request#requestoptions-callback">documentation</a></p></td> + <td class="description last"><p>Options to pass to got. See +<a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">documentation</a></p></td> </tr> @@ -603,7 +603,7 @@ This can be used to extend or override the <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> - <li><a href="https://github.com/request/request#requestoptions-callback">https://github.com/request/request#requestoptions-callback</a></li> + <li><a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">https://github.com/sindresorhus/got/blob/main/documentation/2-options.md</a></li> </ul> </dd> @@ -674,7 +674,7 @@ This can be used to extend or override the <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-json.html b/module-core_base-service_base-json.html index 1185ee252b604f3c2efcb78ca3ffa794665b0c90..a6a23528d5fd81c9314abb5befbf53999e82e3c8 100644 --- a/module-core_base-service_base-json.html +++ b/module-core_base-service_base-json.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html b/module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html index 4edb6dcd8dd952fec81a62bede4e50941569a7da..fab376799bcedfc427634392c87a102185f063ad 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</p> </td> - <td class="description last"><p>Options to pass to request. See -<a href="https://github.com/request/request#requestoptions-callback">documentation</a></p></td> + <td class="description last"><p>Options to pass to got. See +<a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">documentation</a></p></td> </tr> @@ -694,7 +694,7 @@ This can be used to extend or override the <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> - <li><a href="https://github.com/request/request#requestoptions-callback">https://github.com/request/request#requestoptions-callback</a></li> + <li><a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">https://github.com/sindresorhus/got/blob/main/documentation/2-options.md</a></li> </ul> </dd> @@ -765,7 +765,7 @@ This can be used to extend or override the <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-svg-scraping.html b/module-core_base-service_base-svg-scraping.html index dc18e948c912f8c074488485811a2c8c965f8bfd..1f6b0ae9b4306c35af8338bfca7cf2204df904ca 100644 --- a/module-core_base-service_base-svg-scraping.html +++ b/module-core_base-service_base-svg-scraping.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-xml-BaseXmlService.html b/module-core_base-service_base-xml-BaseXmlService.html index 48661e27c790f3ea48dca2539aa9a0fe7f32eaa5..f3804251b693583588a268fffcc7bcc080b61e95 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</p> </td> - <td class="description last"><p>Options to pass to request. See -<a href="https://github.com/request/request#requestoptions-callback">documentation</a></p></td> + <td class="description last"><p>Options to pass to got. See +<a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">documentation</a></p></td> </tr> @@ -484,7 +484,7 @@ This can be used to extend or override the <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> - <li><a href="https://github.com/request/request#requestoptions-callback">https://github.com/request/request#requestoptions-callback</a></li> + <li><a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">https://github.com/sindresorhus/got/blob/main/documentation/2-options.md</a></li> <li><a href="https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json">https://github.com/NaturalIntelligence/fast-xml-parser#xml-to-json</a></li> </ul> @@ -557,7 +557,7 @@ This can be used to extend or override the <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-xml.html b/module-core_base-service_base-xml.html index 84acd5f5a290a63cff61bc31cb61ce8e4da3e876..00aee2380eedb0e6682f570366bf81986adcb169 100644 --- a/module-core_base-service_base-xml.html +++ b/module-core_base-service_base-xml.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-yaml-BaseYamlService.html b/module-core_base-service_base-yaml-BaseYamlService.html index 0c940eeeabed028cfceda99291e5fcd85b39ec85..2e962c02c4b736487cb3f5ebc38c95e1f3ff4317 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</p> </td> - <td class="description last"><p>Options to pass to request. See -<a href="https://github.com/request/request#requestoptions-callback">documentation</a></p></td> + <td class="description last"><p>Options to pass to got. See +<a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">documentation</a></p></td> </tr> @@ -483,7 +483,7 @@ This can be used to extend or override the <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> - <li><a href="https://github.com/request/request#requestoptions-callback">https://github.com/request/request#requestoptions-callback</a></li> + <li><a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">https://github.com/sindresorhus/got/blob/main/documentation/2-options.md</a></li> </ul> </dd> @@ -554,7 +554,7 @@ This can be used to extend or override the <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base-yaml.html b/module-core_base-service_base-yaml.html index b0836a3d21291f067f8abed177d98073c16325a3..ff9dd4b80aae5a3b14127afa8e4c83ae27973998 100644 --- a/module-core_base-service_base-yaml.html +++ b/module-core_base-service_base-yaml.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_base.html b/module-core_base-service_base.html index 5b09a3fa0bff1569ac25973c6b9a07ac2dca4f2f..68ace1818ed6ac76ec3a896818b7e38705661c57 100644 --- a/module-core_base-service_base.html +++ b/module-core_base-service_base.html @@ -219,7 +219,7 @@ configured credentials are present.</p></td> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line537">line 537</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line540">line 540</a> </li></ul></dd> @@ -438,7 +438,7 @@ configured credentials are present.</p></td> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line491">line 491</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line494">line 494</a> </li></ul></dd> @@ -631,7 +631,7 @@ configured credentials are present.</p></td> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line481">line 481</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line484">line 484</a> </li></ul></dd> @@ -897,7 +897,7 @@ users locate relevant badges.</p></td> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line549">line 549</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line552">line 552</a> </li></ul></dd> @@ -1130,7 +1130,7 @@ when the parameter is absent. (Note that in, <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line502">line 502</a> + <a href="core_base-service_base.js.html">core/base-service/base.js</a>, <a href="core_base-service_base.js.html#line505">line 505</a> </li></ul></dd> @@ -1166,7 +1166,7 @@ when the parameter is absent. (Note that in, <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-Deprecated.html b/module-core_base-service_errors-Deprecated.html index fa0f454caeb274ec6330332d3dea1973ae39899a..e01455b37300682b9d8f7d8f6a1be9d3fea6b2bb 100644 --- a/module-core_base-service_errors-Deprecated.html +++ b/module-core_base-service_errors-Deprecated.html @@ -211,7 +211,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-ImproperlyConfigured.html b/module-core_base-service_errors-ImproperlyConfigured.html index eb49418c7ced10d041049aead829db729bb8daf9..a4881ef43224cc902e989de1410116c08e10b379 100644 --- a/module-core_base-service_errors-ImproperlyConfigured.html +++ b/module-core_base-service_errors-ImproperlyConfigured.html @@ -211,7 +211,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-Inaccessible.html b/module-core_base-service_errors-Inaccessible.html index 98f6b44949893d3f618068a682613d074b945595..fbdf81c51a3f4cb862463619569b3e991ee0c89d 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</p></div> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-InvalidParameter.html b/module-core_base-service_errors-InvalidParameter.html index bd4fb1f76c78896286acc527a5005ba3a52ae28b..1380ea38a64a926bce039a9f28b205f87c29b369 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</p></div> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-InvalidResponse.html b/module-core_base-service_errors-InvalidResponse.html index 2c00915c6bdac6292e628f878980038a4c45bb6b..cee64c80c9d6290f55807c257c849d0c49eadaab 100644 --- a/module-core_base-service_errors-InvalidResponse.html +++ b/module-core_base-service_errors-InvalidResponse.html @@ -211,7 +211,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-NotFound.html b/module-core_base-service_errors-NotFound.html index 77e6d7735d1961f8ffba245995d9e232e7e30101..2f7e48dc3efa5175d4c8cc9ad3e577a7eadd6834 100644 --- a/module-core_base-service_errors-NotFound.html +++ b/module-core_base-service_errors-NotFound.html @@ -211,7 +211,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors-ShieldsRuntimeError.html b/module-core_base-service_errors-ShieldsRuntimeError.html index 570bb7a3e6b3cdbb01f27fefed96d1a1eba005a8..f771f075d6ee7a13d29ac20bae766007790b03e1 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_errors.html b/module-core_base-service_errors.html index 9254c312483efd0879ec588543baf0f950570050..b1f64d5538c8f802145406c7992ec7bd5c9fd3fb 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)</p></td> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_base-service_graphql.html b/module-core_base-service_graphql.html index 890d0cd9408b8c0f60259613e2e177f7e20cfa95..1a5c386ef317b1f0cee524cb60f86c659bfd6ea5 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_legacy_regular-update.html b/module-core_legacy_regular-update.html index e2bfbe0f1c4e9ca65f677a00061fdd45cba4183e..7cf7f38d659ff818d4f9bae3e97e173fc1221ed6 100644 --- a/module-core_legacy_regular-update.html +++ b/module-core_legacy_regular-update.html @@ -495,7 +495,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_server_server-Server.html b/module-core_server_server-Server.html index 328ac9b1dfaf1a8a68a74c68c1c9b80a689deb1d..ab6d75e2b700b211c9bf42312d7ea0c815c94308 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()</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_server_server.html b/module-core_server_server.html index f447001ef681cd5f65b56d3902188498a5bfd0c7..00e307eade4fd9d859da82f59dd6024a8c14fdf2 100644 --- a/module-core_server_server.html +++ b/module-core_server_server.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_create-service-tester.html b/module-core_service-test-runner_create-service-tester.html index 088e617b3b242d2e80f9344106c0cd342e2f8447..7c633d73b1ae20723a9f71c7b968bb6737cf0888 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_icedfrisby-shields.html b/module-core_service-test-runner_icedfrisby-shields.html index 8f8d56ac5938ca501152e18c0c3a492e85067261..d29947239f9143ae533fdbba6229a88af103a1a6 100644 --- a/module-core_service-test-runner_icedfrisby-shields.html +++ b/module-core_service-test-runner_icedfrisby-shields.html @@ -250,7 +250,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_infer-pull-request.html b/module-core_service-test-runner_infer-pull-request.html index 682f029acaab7a535f6f1eaba56d98c2c517e6a2..0a5d225db2f16c5f2497163ce55e4478e76fed9e 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_runner-Runner.html b/module-core_service-test-runner_runner-Runner.html index 8732bccce323b8396e86beb99fe85b54244802b3..9cc33419d00a41fc50e01a3b92b33dee51d30f49 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_runner.html b/module-core_service-test-runner_runner.html index 8d0f54851fdfb9d93d1595e045e853e5d6011635..8c18144d4c20f6656eeb02a8bbbaf2870acbcd39 100644 --- a/module-core_service-test-runner_runner.html +++ b/module-core_service-test-runner_runner.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_service-tester-ServiceTester.html b/module-core_service-test-runner_service-tester-ServiceTester.html index a24f7be670c2b12ad5b948c738cae880808db065..ffe2beae5fb2df18c8080740edafaa7e17ddd191 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_service-tester.html b/module-core_service-test-runner_service-tester.html index 3a735c7b9740491d418be588a26aacb336c238c4..722e25b98dcdb44ad3a2344f4d61ca64187ea5db 100644 --- a/module-core_service-test-runner_service-tester.html +++ b/module-core_service-test-runner_service-tester.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_service-test-runner_services-for-title.html b/module-core_service-test-runner_services-for-title.html index 5e853cda5c2827391996f4eba55f2beab90e45fb..23e1d326152ead81aee2ad1a97fcc5ec97b431b2 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_token-pooling_token-pool-Token.html b/module-core_token-pooling_token-pool-Token.html index 88434f6412859c3235154b4e7cad5c64cb9af10c..ea9434517d21dab8b5215529567709c868bbfa22 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_token-pooling_token-pool-TokenPool.html b/module-core_token-pooling_token-pool-TokenPool.html index 8013bc1434b4d32f6d8dcc0b0e388fd0fe425bdf..bd9b5dc4578ebe6fbfdd1b83be23f0fe62dc89d7 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.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-core_token-pooling_token-pool.html b/module-core_token-pooling_token-pool.html index a0480047a23a4f21a477ae76d5381c6d148e1f34..9ba8b16c271b851536c17d6724474d8402a95210 100644 --- a/module-core_token-pooling_token-pool.html +++ b/module-core_token-pooling_token-pool.html @@ -249,7 +249,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-services_downloads.html b/module-services_downloads.html index 70f4f94cb6e97a6c574190458db3ab0f66312c7b..e139b4f0a411145f4b87c3977dde8f34ebf84b26 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. <code>foobar@v1.23</code>. D <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-services_dynamic_json-path.html b/module-services_dynamic_json-path.html index a485b09e9c4bb830da77d042a42e15608fc92b7b..834cdad16014bfe7be857037ea636ebe70043523 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 <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-services_steam_steam-base-BaseSteamAPI.html b/module-services_steam_steam-base-BaseSteamAPI.html index 3d55dd64e982a488d0bbbcc0bdc6711027d32f89..d550fb18bbff59bf0d86c542fdc777be79870c2a 100644 --- a/module-services_steam_steam-base-BaseSteamAPI.html +++ b/module-services_steam_steam-base-BaseSteamAPI.html @@ -380,7 +380,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/module-services_steam_steam-base.html b/module-services_steam_steam-base.html index 2fc106a75b8ba2c3606934a21d7443b5bcf2383d..9ce09d90caa9674398b4004974fa2cb8a737235f 100644 --- a/module-services_steam_steam-base.html +++ b/module-services_steam_steam-base.html @@ -83,7 +83,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/services_downloads.js.html b/services_downloads.js.html index 727ad1458326f86e9dfa8a093c5a405ce0c3b019..d34c73a24a072f42d8c5973ab1ed319f4b91a379 100644 --- a/services_downloads.js.html +++ b/services_downloads.js.html @@ -101,7 +101,7 @@ export { renderDownloadsBadge } <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/services_dynamic_json-path.js.html b/services_dynamic_json-path.js.html index 62c29e9062707ab82ca05bf3720c6490834b37ec..3ea7f450e1b7e600d0bfe494aa0f79a0ee0028b5 100644 --- a/services_dynamic_json-path.js.html +++ b/services_dynamic_json-path.js.html @@ -120,7 +120,7 @@ export default superclass => <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/services_packagist_packagist-base.js.html b/services_packagist_packagist-base.js.html index c26e2804cfcbe303b62e0e25393cf4ee0a80280f..e950e1258957d8cf7535dd5e140d1bfb3998ec33 100644 --- a/services_packagist_packagist-base.js.html +++ b/services_packagist_packagist-base.js.html @@ -150,7 +150,7 @@ export { <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/services_steam_steam-base.js.html b/services_steam_steam-base.js.html index 2d0c908b3b52f95c62e39cfc5b2ebb970855c1b3..935bc82d5a24116099abf1b50c76f64596a2e50c 100644 --- a/services_steam_steam-base.js.html +++ b/services_steam_steam-base.js.html @@ -98,7 +98,7 @@ export default BaseSteamAPI <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/services_test-validators.js.html b/services_test-validators.js.html index 2a6609f61f293bd2e6b77ed75d1e40f763db7cf2..dcac2d0f00999b10902f81d3d532425a25594a0e 100644 --- a/services_test-validators.js.html +++ b/services_test-validators.js.html @@ -223,7 +223,7 @@ export { <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-TUTORIAL.html b/tutorial-TUTORIAL.html index 0741637fc66b0e49febe7d8b33e1e07ab72b19cf..4785220e01ab1e65ce474975bb2487de52031c65 100644 --- a/tutorial-TUTORIAL.html +++ b/tutorial-TUTORIAL.html @@ -260,12 +260,12 @@ export default class GemVersion extends BaseJsonService { <p>Working our way upward, the <code>async fetch()</code> method is responsible for calling an API endpoint to get data. Extending <code>BaseJsonService</code> gives us the helper function <code>_requestJson()</code>. Note here that we pass the schema we defined in step 4 as an argument. <code>_requestJson()</code> will deal with validating the response against the schema and throwing an error if necessary.</p> <ul> <li><code>_requestJson()</code> automatically adds an Accept header, checks the status code, parses the response as JSON, and returns the parsed response.</li> -<li><code>_requestJson()</code> uses <a href="https://github.com/request/request">request</a> to perform the HTTP request. Options can be passed to request, including method, query string, and headers. If headers are provided they will override the ones automatically set by <code>_requestJson()</code>. There is no need to specify json, as the JSON parsing is handled by <code>_requestJson()</code>. See the <code>request</code> docs for <a href="https://github.com/request/request#requestoptions-callback">supported options</a>.</li> +<li><code>_requestJson()</code> uses <a href="https://github.com/sindresorhus/got">got</a> to perform the HTTP request. Options can be passed to got, including method, query string, and headers. If headers are provided they will override the ones automatically set by <code>_requestJson()</code>. There is no need to specify json, as the JSON parsing is handled by <code>_requestJson()</code>. See the <code>got</code> docs for <a href="https://github.com/sindresorhus/got/blob/main/documentation/2-options.md">supported options</a>.</li> <li>Error messages corresponding to each status code can be returned by passing a dictionary of status codes -> messages in <code>errorMessages</code>.</li> <li>A more complex call to <code>_requestJson()</code> might look like this:<pre class="prettyprint source lang-js"><code>return this._requestJson({ schema: mySchema, url, - options: { qs: { branch: 'master' } }, + options: { searchParams: { branch: 'master' } }, errorMessages: { 401: 'private application not supported', 404: 'application not found', @@ -377,7 +377,7 @@ will review your contribution.</li> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-adding-new-config-values.html b/tutorial-adding-new-config-values.html index ddd59babcfa331ba6cafae8c2bd91fddd80d8999..9130baaad7bb8c8c79ad80720e6c988cd615bd6f 100644 --- a/tutorial-adding-new-config-values.html +++ b/tutorial-adding-new-config-values.html @@ -60,7 +60,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-badge-urls.html b/tutorial-badge-urls.html index 140c1661d1dfe36db8b6e290f459ca4c7f2ff8fc..f2b214fe80e18c3690f18f4be37db8025cb48e7c 100644 --- a/tutorial-badge-urls.html +++ b/tutorial-badge-urls.html @@ -77,7 +77,7 @@ badge is for issues, and the parameters are <code>:user/:repo</code>.</li> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-code-walkthrough.html b/tutorial-code-walkthrough.html index 5a88394477604aaead25875580bda953baf2f479..bf9dc64bec3c8637c2a1ea027f91bdb8f8e5458f 100644 --- a/tutorial-code-walkthrough.html +++ b/tutorial-code-walkthrough.html @@ -240,7 +240,7 @@ result over the HTTPS connection.</li> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-deprecating-badges.html b/tutorial-deprecating-badges.html index 2a7ccb2f35934f605b7fb4085de60c7ead01bef5..85201f3038e799662498e86b5012d3e9d2a8a1a3 100644 --- a/tutorial-deprecating-badges.html +++ b/tutorial-deprecating-badges.html @@ -140,7 +140,7 @@ t.create('no longer available (previously number of layers)') <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-input-validation.html b/tutorial-input-validation.html index 3ec0eb7da76af8cc0de404d74e2bb261df077bb9..225ca09f2768f58b333d1a9e5ac6b4057e8d5af4 100644 --- a/tutorial-input-validation.html +++ b/tutorial-input-validation.html @@ -103,7 +103,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-json-format.html b/tutorial-json-format.html index b09917e556419e90446880c73642ecbe16a24902..713d72994b992bae502fbf87f63fd2acafd63c26 100644 --- a/tutorial-json-format.html +++ b/tutorial-json-format.html @@ -60,7 +60,7 @@ if you have any queries regarding the JSON format.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-logos.html b/tutorial-logos.html index b276c07f6ee9f7573de75572915847ff0f223147..1fda1e499546b24150eaee79dda0a7cbab0b854b 100644 --- a/tutorial-logos.html +++ b/tutorial-logos.html @@ -96,7 +96,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-performance-testing.html b/tutorial-performance-testing.html index 011aae7bd71ecc8dd72267ed7c6d7b97e9958ee4..a58f73d6353f7eb95b230959e26b31106503fef7 100644 --- a/tutorial-performance-testing.html +++ b/tutorial-performance-testing.html @@ -76,7 +76,7 @@ node --prof-process --preprocess -j isolate-00000244AB6ED3B0-11920-v8.log | flam <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-production-hosting.html b/tutorial-production-hosting.html index cd596c0fe73a281a00c06b8c7334bc065d07d9e0..55f384270ca634fa92f3a7c9423f68a9ecd8ec76 100644 --- a/tutorial-production-hosting.html +++ b/tutorial-production-hosting.html @@ -253,7 +253,7 @@ the server. It's generously donated by <a href="https://sentry.io/shields/">Sent <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-releases.html b/tutorial-releases.html index dbf35337aa75c934beb2043131915da030be9aa3..01baa0ca18c8a0ca9f0457583a5aa49810d15efd 100644 --- a/tutorial-releases.html +++ b/tutorial-releases.html @@ -79,7 +79,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-self-hosting.html b/tutorial-self-hosting.html index 6e0e5a442a1a4c6195baf8dae7b49c2d69d08c1f..c7d4b0d2e94b4bfcd06a6bf686700e2dde9aff14 100644 --- a/tutorial-self-hosting.html +++ b/tutorial-self-hosting.html @@ -176,7 +176,7 @@ Set <code>public.requireCloudflare: true</code>.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-server-secrets.html b/tutorial-server-secrets.html index d5e2d4219b00c34f55581001dadfd7244ddd55a2..a001caef2e85a5d425db5d5167ef0f07d321c2b3 100644 --- a/tutorial-server-secrets.html +++ b/tutorial-server-secrets.html @@ -279,7 +279,7 @@ and create an API key for the YouTube Data API v3.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> diff --git a/tutorial-service-tests.html b/tutorial-service-tests.html index bb3d711afa80b66d3e07fc9118ee66cedfebb019..3af081a50c355efa8ab62ae8877a9a89595326bf 100644 --- a/tutorial-service-tests.html +++ b/tutorial-service-tests.html @@ -246,7 +246,7 @@ comment there instead.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:40:53 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon Nov 15 2021 19:57:34 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script>