Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
axiosCircuitBreaker
✓ import { axiosCircuitBreaker } from 'axios-circuit-breaker'
✗ const axiosCircuitBreaker = require('axios-circuit-breaker')
Default export not available; use named import. ESM only.
CircuitBreakerOpenError
✓ import { CircuitBreakerOpenError } from 'axios-circuit-breaker'
✗ import CircuitBreakerOpenError from 'axios-circuit-breaker';
Error class is exported as a named export, not default.
CircuitBreakerHalfOpenError
✓ import { CircuitBreakerHalfOpenError } from 'axios-circuit-breaker'
✗ const { CircuitBreakerHalfOpenError } = require('axios-circuit-breaker');
CommonJS require works but ESM import is preferred.
Creates an Axios instance, applies circuit breaker interceptor with custom config, and handles CircuitBreakerOpenError.
import axios from 'axios';
import { axiosCircuitBreaker, CircuitBreakerOpenError } from 'axios-circuit-breaker';
const instance = axios.create({ baseURL: 'http://localhost:3000' });
axiosCircuitBreaker(instance, {
id: 'MyService',
threshold: 10,
thresholdPeriodMs: 5000,
resetPeriodMs: 10000,
numRequestsToCloseCircuit: 5,
isFault: (error) => error.response?.status >= 500,
logger: (msg) => console.log(msg)
});
async function makeRequest() {
try {
const response = await instance.get('/api/data');
console.log(response.data);
} catch (error) {
if (error instanceof CircuitBreakerOpenError) {
console.error('Circuit breaker is open, request blocked.');
} else {
console.error('Request failed:', error.message);
}
}
}
makeRequest();
Errors
Common errors & fixes
Module not found: Can't resolve 'axios-circuit-breaker'
Missing npm install or import path incorrect.
fixRun 'npm install axios-circuit-breaker' and ensure import path is valid.
TypeError: axiosCircuitBreaker is not a function
Default import used instead of named import.
fixUse import { axiosCircuitBreaker } from 'axios-circuit-breaker'. Error: Cannot find module 'axios-circuit-breaker'
Package not installed or node_modules missing.
fixRun 'npm install' or 'npm install axios-circuit-breaker'.
Audit
Dependencies
axiosrequiredpeer dependency: axios is required (version 1.x) to intercept requests.