Examples

Real-world examples demonstrating how to use @nodelibraries/circuit-breaker.

Basic Examples

• Basic Usage - Simple example showing basic usage
• Error Handling - How to handle errors with circuit breakers

Framework Integration

• NestJS Integration - Using circuit breakers in NestJS applications
• Express Integration - Using circuit breakers in Express applications

Advanced Examples

• Advanced Configuration - Advanced configuration options
• Multiple Circuit Breakers - Managing multiple circuit breakers

Use Cases

API Calls

Protect external API calls from failures:

import { CircuitBreaker, CircuitBreakerLevel } from '@nodelibraries/circuit-breaker';
import axios from 'axios';

const circuitBreaker = new CircuitBreaker();

async function fetchUserData(userId: number) {
  const response = await axios.get(`https://api.example.com/users/${userId}`);
  return response.data;
}

const user = await circuitBreaker.execute({
  level: CircuitBreakerLevel.External,
  name: 'fetchUserData',
  requestFn: fetchUserData,
  args: [userId],
  fallbackFn: () => ({ id: userId, name: 'Unknown User' }),
});

Database Operations

Protect database operations:

const result = await circuitBreaker.execute({
  level: CircuitBreakerLevel.Database,
  name: 'findUser',
  requestFn: db.findUser,
  args: [userId],
  fallbackFn: () => null,
});

Service Calls

Protect service-to-service calls:

const result = await circuitBreaker.execute({
  level: CircuitBreakerLevel.Service,
  name: 'paymentService',
  requestFn: paymentService.processPayment,
  args: [paymentData],
  fallbackFn: () => ({ status: 'failed', reason: 'Service unavailable' }),
});

Next Steps

• Read the Getting Started Guide
• Explore the API Reference
• Check out more Examples