Module: core/base-service/errors

Standard exceptions for handling error cases

Source:

Classes

Deprecated
ImproperlyConfigured
Inaccessible
InvalidParameter
InvalidResponse
NotFound
ShieldsRuntimeError

Type Definitions

RuntimeErrorProps

Type:
  • object
Properties:
Name Type Description
underlyingError Error

Exception we are wrapping (Optional)
response object

Response from an upstream API to provide context for the error (Optional)
prettyMessage string

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)
cacheSeconds number

Length of time to cache this error response for. Defaults to the cacheLength of the service class throwing the error (Optional)
Source: