Class: CircuitOpenError
Defined in: src/shield/errors/index.ts:391 Error when circuit breaker is openExtends
Constructors
Constructor
Parameters
circuitName
string
openedAt
Date
resetMs
number
Returns
CircuitOpenError
Overrides
Properties
cause?
Inherited from
circuitName
code
Inherited from
context
Inherited from
isRetryable
Inherited from
message
Inherited from
name
Inherited from
openedAt
remediation
Inherited from
resetAt
retryAfterMs?
Inherited from
stack?
Inherited from
stackTraceLimit
Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
Inherited from
Methods
toJSON()
Returns
SerializedError & {
circuitName: string;
openedAt: string;
resetAt: string;
}
Overrides
toString()
Returns
string
Inherited from
captureStackTrace()
.stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
prepareStackTrace()
Parameters
err
Error
stackTraces
CallSite[]
Returns
any