refactor(types): update CircuitBreakerResult to indicate if a fallback response was provided

jkyberneees · jkyberneees · commit 41ecb7971bb8 · 2025-07-13T10:03:55.000+02:00
diff --git a/README.md b/README.md
@@ -135,6 +135,7 @@ interface CircuitBreakerResult {
   state: CircuitState // Current circuit breaker state
   failureCount: number // Current failure count
   executionTimeMs: number // Execution time in milliseconds
+  fallbackResponseProvided?: boolean // Whether a fallback response was provided
 }
 ```
 
diff --git a/src/types.ts b/src/types.ts
@@ -95,7 +95,7 @@ export interface CircuitBreakerResult {
   state: CircuitState
   failureCount: number
   executionTimeMs: number
-  fallbackResponse?: Response | void
+  fallbackResponseProvided?: boolean
 }
 
 export enum CircuitState {

Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,7 @@ interface CircuitBreakerResult {`
`135`	`135`	`state: CircuitState // Current circuit breaker state`
`136`	`136`	`failureCount: number // Current failure count`
`137`	`137`	`executionTimeMs: number // Execution time in milliseconds`
	`138`	`+ fallbackResponseProvided?: boolean // Whether a fallback response was provided`
`138`	`139`	`}`
`139`	`140`	```
`140`	`141`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ export interface CircuitBreakerResult {`
`95`	`95`	`state: CircuitState`
`96`	`96`	`failureCount: number`
`97`	`97`	`executionTimeMs: number`
`98`		`- fallbackResponse?: Response \| void`
	`98`	`+ fallbackResponseProvided?: boolean`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`export enum CircuitState {`