BrokenCircuitError

Defined in: src/core.ts:472

A strategy refused to start the call (open circuit, full limiter, lock held). The dependency was never called, so these are never counted by circuit breakers and not retried by default.

Extends

• CallRejectedError

Extended by

• IsolatedCircuitError

Constructors

Constructor

new BrokenCircuitError(message?, retryAfter?, options?): BrokenCircuitError

Defined in: src/core.ts:477

Parameters

message?

string = 'The circuit is now open and is not allowing calls.'

retryAfter?

number

options?

ErrorOptions

Returns

BrokenCircuitError

Overrides

CallRejectedError.constructor

Properties

cause?

optional cause?: unknown

Defined in: site/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

CallRejectedError.cause

---

code

code: "CIRCUIT_OPEN" | "CIRCUIT_ISOLATED" = 'CIRCUIT_OPEN'

Defined in: src/core.ts:474

Overrides

CallRejectedError.code

---

message

message: string

Defined in: site/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

CallRejectedError.message

---

name

name: string = 'BrokenCircuitError'

Defined in: src/core.ts:473

Overrides

CallRejectedError.name

---

retryAfter

readonly retryAfter: number | undefined

Defined in: src/core.ts:476

Milliseconds until the circuit allows a probe call.

---

source

source: TelemetrySource | undefined

Defined in: src/core.ts:407

Pipeline and strategy that raised it (set by the strategy).

Inherited from

CallRejectedError.source

---

stack?

optional stack?: string

Defined in: site/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

CallRejectedError.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

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

CallRejectedError.stackTraceLimit

Methods

toJSON()

toJSON(): Record<string, unknown>

Defined in: src/core.ts:415

Returns

Record<string, unknown>

Inherited from

CallRejectedError.toJSON

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

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

CallRejectedError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

CallRejectedError.prepareStackTrace