Skip to main content
Dotset CLI API Documentation / index / CircuitOpenError

Class: CircuitOpenError

Defined in: src/shield/errors/index.ts:391 Error when circuit breaker is open

Extends

Constructors

Constructor

new CircuitOpenError(
   circuitName, 
   openedAt, 
   resetMs): CircuitOpenError;
Defined in: src/shield/errors/index.ts:396

Parameters

circuitName
string
openedAt
Date
resetMs
number

Returns

CircuitOpenError

Overrides

Properties

cause?

readonly optional cause: Error;
Defined in: src/shield/errors/index.ts:145

Inherited from

circuitName

readonly circuitName: string;
Defined in: src/shield/errors/index.ts:392

code

readonly code: ErrorCode;
Defined in: src/shield/errors/index.ts:142

Inherited from

context

readonly context: ErrorContext;
Defined in: src/shield/errors/index.ts:146

Inherited from

isRetryable

readonly isRetryable: boolean;
Defined in: src/shield/errors/index.ts:143

Inherited from

message

message: string;
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

openedAt

readonly openedAt: Date;
Defined in: src/shield/errors/index.ts:393

remediation

readonly remediation: string[];
Defined in: src/shield/errors/index.ts:147

Inherited from

resetAt

readonly resetAt: Date;
Defined in: src/shield/errors/index.ts:394

retryAfterMs?

readonly optional retryAfterMs: number;
Defined in: src/shield/errors/index.ts:144

Inherited from

stack?

optional stack: string;
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

stackTraceLimit

static stackTraceLimit: number;
Defined in: node_modules/@types/node/globals.d.ts:68 The 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()

toJSON(): SerializedError & {
  circuitName: string;
  openedAt: string;
  resetAt: string;
};
Defined in: src/shield/errors/index.ts:413

Returns

SerializedError & { circuitName: string; openedAt: string; resetAt: string; }

Overrides

toString()

toString(): string;
Defined in: src/shield/errors/index.ts:193 Returns a string representation of an object.

Returns

string

Inherited from

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;
Defined in: node_modules/@types/node/globals.d.ts:52 Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
The first line of the trace will be prefixed with ${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:
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject
object
constructorOpt?
Function

Returns

void

Inherited from

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;
Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err
Error
stackTraces
CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from