275 lines
13 KiB
HTML
275 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: core/base-service/errors.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: core/base-service/errors.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Standard exceptions for handling error cases
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
/**
|
|
* Base error class
|
|
*
|
|
* @abstract
|
|
*/
|
|
class ShieldsRuntimeError extends Error {
|
|
/**
|
|
* Name of the class. Implementations of ShieldsRuntimeError
|
|
* should override this method.
|
|
*
|
|
* @type {string}
|
|
*/
|
|
get name() {
|
|
return 'ShieldsRuntimeError'
|
|
}
|
|
|
|
/**
|
|
* Default message for this exception if none is specified.
|
|
* Implementations of ShieldsRuntimeError should implement this method.
|
|
*
|
|
* @abstract
|
|
* @type {string}
|
|
*/
|
|
get defaultPrettyMessage() {
|
|
throw new Error('Must implement abstract method')
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
* @param {string} message Exception message for debug purposes
|
|
*/
|
|
constructor(props = {}, message) {
|
|
super(message)
|
|
this.prettyMessage = props.prettyMessage || this.defaultPrettyMessage
|
|
if (props.underlyingError) {
|
|
this.stack = props.underlyingError.stack
|
|
}
|
|
this.cacheSeconds = props.cacheSeconds
|
|
}
|
|
}
|
|
|
|
const defaultNotFoundError = 'not found'
|
|
|
|
/**
|
|
* Throw this to wrap a 404 or other 'not found' response from an upstream API
|
|
*/
|
|
class NotFound extends ShieldsRuntimeError {
|
|
get name() {
|
|
return 'NotFound'
|
|
}
|
|
|
|
get defaultPrettyMessage() {
|
|
return defaultNotFoundError
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
*/
|
|
constructor(props = {}) {
|
|
const prettyMessage = props.prettyMessage || defaultNotFoundError
|
|
const message =
|
|
prettyMessage === defaultNotFoundError
|
|
? 'Not Found'
|
|
: `Not Found: ${prettyMessage}`
|
|
super(props, message)
|
|
this.response = props.response
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Throw this to wrap an invalid or unexpected response from an upstream API
|
|
*/
|
|
class InvalidResponse extends ShieldsRuntimeError {
|
|
get name() {
|
|
return 'InvalidResponse'
|
|
}
|
|
|
|
get defaultPrettyMessage() {
|
|
return 'invalid'
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
*/
|
|
constructor(props = {}) {
|
|
const message = props.underlyingError
|
|
? `Invalid Response: ${props.underlyingError.message}`
|
|
: 'Invalid Response'
|
|
super(props, message)
|
|
this.response = props.response
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Throw this if we can't contact an upstream API
|
|
* or to wrap a 5XX response
|
|
*/
|
|
class Inaccessible extends ShieldsRuntimeError {
|
|
get name() {
|
|
return 'Inaccessible'
|
|
}
|
|
|
|
get defaultPrettyMessage() {
|
|
return 'inaccessible'
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
*/
|
|
constructor(props = {}) {
|
|
const message = props.underlyingError
|
|
? `Inaccessible: ${props.underlyingError.message}`
|
|
: 'Inaccessible'
|
|
super(props, message)
|
|
this.response = props.response
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Throw this error when required credentials are missing
|
|
*/
|
|
class ImproperlyConfigured extends ShieldsRuntimeError {
|
|
get name() {
|
|
return 'ImproperlyConfigured'
|
|
}
|
|
|
|
get defaultPrettyMessage() {
|
|
return 'improperly configured'
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
*/
|
|
constructor(props = {}) {
|
|
const message = props.underlyingError
|
|
? `ImproperlyConfigured: ${props.underlyingError.message}`
|
|
: 'ImproperlyConfigured'
|
|
super(props, message)
|
|
this.response = props.response
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Throw this error when a user supplied input or parameter
|
|
* is invalid or unexpected
|
|
*/
|
|
class InvalidParameter extends ShieldsRuntimeError {
|
|
get name() {
|
|
return 'InvalidParameter'
|
|
}
|
|
|
|
get defaultPrettyMessage() {
|
|
return 'invalid parameter'
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
*/
|
|
constructor(props = {}) {
|
|
const message = props.underlyingError
|
|
? `Invalid Parameter: ${props.underlyingError.message}`
|
|
: 'Invalid Parameter'
|
|
super(props, message)
|
|
this.response = props.response
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Throw this error to indicate that a service is deprecated or removed
|
|
*/
|
|
class Deprecated extends ShieldsRuntimeError {
|
|
get name() {
|
|
return 'Deprecated'
|
|
}
|
|
|
|
get defaultPrettyMessage() {
|
|
return 'no longer available'
|
|
}
|
|
|
|
/**
|
|
* @param {module:core/base-service/errors~RuntimeErrorProps} props
|
|
* Refer to individual attrs
|
|
*/
|
|
constructor(props) {
|
|
const message = 'Deprecated'
|
|
super(props, message)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @typedef {object} RuntimeErrorProps
|
|
* @property {Error} underlyingError Exception we are wrapping (Optional)
|
|
* @property {object} response Response from an upstream API to provide
|
|
* context for the error (Optional)
|
|
* @property {string} prettyMessage User-facing error message to override the
|
|
* value of `defaultPrettyMessage()`. This is the text that will appear on the
|
|
* badge when we catch and render the exception (Optional)
|
|
* @property {number} cacheSeconds Length of time to cache this error response
|
|
* for. Defaults to the cacheLength of the service class throwing the error
|
|
* (Optional)
|
|
*/
|
|
|
|
export {
|
|
ShieldsRuntimeError,
|
|
NotFound,
|
|
ImproperlyConfigured,
|
|
InvalidResponse,
|
|
Inaccessible,
|
|
InvalidParameter,
|
|
Deprecated,
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-badge-maker_lib_xml.html">badge-maker/lib/xml</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-toml.html">core/base-service/base-toml</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_base-service_openapi.html">core/base-service/openapi</a></li><li><a href="module-core_base-service_resource-cache.html">core/base-service/resource-cache</a></li><li><a href="module-core_base-service_service-definitions.html">core/base-service/service-definitions</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_build-status.html">services/build-status</a></li><li><a href="module-services_color-formatters.html">services/color-formatters</a></li><li><a href="module-services_contributor-count.html">services/contributor-count</a></li><li><a href="module-services_date.html">services/date</a></li><li><a href="module-services_downloads.html">services/downloads</a></li><li><a href="module-services_dynamic-common.html">services/dynamic-common</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_endpoint-common.html">services/endpoint-common</a></li><li><a href="module-services_licenses.html">services/licenses</a></li><li><a href="module-services_package-json-helpers.html">services/package-json-helpers</a></li><li><a href="module-services_php-version.html">services/php-version</a></li><li><a href="module-services_pipenv-helpers.html">services/pipenv-helpers</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_size.html">services/size</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li><li><a href="module-services_text-formatters.html">services/text-formatters</a></li><li><a href="module-services_validators.html">services/validators</a></li><li><a href="module-services_version.html">services/version</a></li><li><a href="module-services_website-status.html">services/website-status</a></li><li><a href="module-services_winget_version.html">services/winget/version</a></li></ul><h3>Classes</h3><ul><li><a href="BaseThunderstoreService.html">BaseThunderstoreService</a></li><li><a href="module-badge-maker_lib_xml-ElementList.html">ElementList</a></li><li><a href="module-badge-maker_lib_xml-XmlElement.html">XmlElement</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-toml-BaseTomlService.html">BaseTomlService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-adding-new-config-values.html">adding-new-config-values</a></li><li><a href="tutorial-authentication.html">authentication</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li><li><a href="tutorial-static-badges.html">static-badges</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createNumRequestCounter">createNumRequestCounter</a></li><li><a href="global.html#fakeJwtToken">fakeJwtToken</a></li><li><a href="global.html#generateFakeConfig">generateFakeConfig</a></li><li><a href="global.html#getBadgeExampleCall">getBadgeExampleCall</a></li><li><a href="global.html#getServiceClassAuthOrigin">getServiceClassAuthOrigin</a></li><li><a href="global.html#isMetricWithPattern">isMetricWithPattern</a></li><li><a href="global.html#testAuth">testAuth</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Mar 28 2025 18:26:11 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|