Connectum API Reference / @connectum/interceptors / circuit-breaker / createCircuitBreakerInterceptor

Function: createCircuitBreakerInterceptor()

createCircuitBreakerInterceptor(options?): Interceptor

Defined in: circuit-breaker.ts:61

Create circuit breaker interceptor

Prevents cascading failures by opening circuit after consecutive failures. When circuit is open, requests fail immediately without calling the service.

Circuit States:

• Closed (normal): Requests pass through
• Open (failing): Requests rejected immediately
• Half-Open (testing): Single request allowed to test recovery

Parameters

options?

CircuitBreakerOptions = {}

Circuit breaker options

Returns

Interceptor

ConnectRPC interceptor

Examples

import { createServer } from '@connectum/core';
import { createCircuitBreakerInterceptor } from '@connectum/interceptors';
import { myRoutes } from './routes.js';

const server = createServer({
  services: [myRoutes],
  interceptors: [
    createCircuitBreakerInterceptor({
      threshold: 5,           // Open after 5 consecutive failures
      halfOpenAfter: 30000,   // Try again after 30 seconds
      skipStreaming: true,    // Skip streaming calls
    }),
  ],
});

await server.start();

import { createConnectTransport } from '@connectrpc/connect-node';
import { createCircuitBreakerInterceptor } from '@connectum/interceptors';

const transport = createConnectTransport({
  baseUrl: 'http://localhost:5000',
  interceptors: [
    createCircuitBreakerInterceptor({ threshold: 3 }),
  ],
});