breaker-box 1.0.0 → 2.0.0

package/README.md

@@ -27,9 +27,10 @@ async function unreliableApiCall(data: string) {
 }
 
 const protectedApiCall = createCircuitBreaker(unreliableApiCall, {
-	failureThreshold: 1, // Open circuit after first failure
-	resetAfter: 30_000, // Try again after 30 seconds
-	errorIsFailure: (error) => true,
+	errorIsFailure: () => true, // Any error is considered a failure
+	failureThreshold: 1,        // Open circuit after first failure
+	fallback: undefined,        // No fallback, errors are propagated
+	resetAfter: 30_000,         // Try again after 30 seconds
 })
 
 try {
@@ -43,22 +44,13 @@ try {
 ### Event Monitoring
 
 ```typescript
-const protectedFunction = createCircuitBreaker(unreliableApiCall)
-
-protectedFunction.on("open", (cause) => {
-	console.log("Circuit opened due to:", cause.message)
-})
-
-protectedFunction.on("close", () => {
-	console.log("Circuit closed - normal operation resumed")
-})
-
-protectedFunction.on("reject", (error) => {
-	console.log("Function call rejected:", error.message)
-})
-
-protectedFunction.on("resolve", () => {
-	console.log("Function call succeeded")
+const protectedFunction = createCircuitBreaker(unreliableApiCall, {
+	onClose: () => {
+		console.log("Circuit closed - normal operation resumed")
+	},
+	onOpen: (cause) => {
+		console.log("Circuit opened due to:", cause.message)
+	},
 })
 
 // Check current state
@@ -83,26 +75,20 @@ Creates a circuit breaker around the provided async function.
 
 - `fn`: The async function to protect
 - `options`: Configuration object (optional)
+    - `errorIsFailure`: Function to determine if an error counts as failure (default: all errors)
     - `failureThreshold`: Number of failures before opening circuit (default: 1)
+    - `fallback`: Function to call when circuit is open (default: undefined)
+	- `onClose`: Function to call when circuit is closed (default: undefined)
+	- `onOpen`: Function to call when circuit is opened (default: undefined)
     - `resetAfter`: Milliseconds to wait before trying again (default: 30000)
-    - `errorIsFailure`: Function to determine if an error counts as failure (default: all errors)
-    - `fallback`: Function to call when circuit is open (default: throws CircuitOpenError)
 
 #### Returns
 
 A function with the same signature as `fn` and additional methods:
 
-- `.getState()`: Returns current circuit state
-- `.on(event, listener)`: Add event listener
-- `.off(event, listener)`: Remove event listener
 - `.dispose()`: Clean up resources
-
-#### Events
-
-- `open`: Circuit opened due to failures
-- `close`: Circuit closed and resumed normal operation
-- `reject`: Function call was rejected
-- `resolve`: Function call succeeded
+- `.getLatestError()`: Returns the error which triggered the circuit breaker
+- `.getState()`: Returns current circuit state
 
 ### Development
 

package/dist/index.cjs

@@ -1,88 +1,69 @@
 'use strict';
 
-var EventEmitter = require('node:events');
-
-const assertNever = (value, message = "Unexpected value") => (
-  /* v8 ignore next */
-  new TypeError(`${message}: ${value}`)
-);
-
 function createCircuitBreaker(main, options = {}) {
-  const events = new EventEmitter();
   const {
     errorIsFailure = () => true,
     failureThreshold = 1,
-    fallback = () => {
-      const cause = failureCause;
-      const msg = cause instanceof Error ? cause.message : "Unknown";
-      throw new Error(`CircuitOpenError: ${msg}`, { cause });
-    },
+    fallback = () => Promise.reject(failureCause),
+    onClose,
+    onOpen,
     resetAfter = 3e4
   } = options;
+  let halfOpenPending;
   let state = "closed";
   let failureCause = void 0;
   let failureCount = 0;
   let resetTimer = void 0;
   function openCircuit(cause) {
-    if (state === "disposed") return;
     state = "open";
-    events.emit("open", cause);
-    failureCause = cause;
+    onOpen?.(cause);
     clearTimeout(resetTimer);
     resetTimer = setTimeout(() => state = "halfOpen", resetAfter);
   }
   function closeCircuit() {
-    if (state === "disposed") return;
-    if (state === "halfOpen") events.emit("close");
     state = "closed";
     failureCause = void 0;
     failureCount = 0;
     clearTimeout(resetTimer);
   }
-  const mainWithEmit = async (...args) => {
-    try {
-      const result = await main(...args);
-      events.emit("resolve");
-      closeCircuit();
-      return result;
-    } catch (cause) {
-      events.emit("reject", cause);
-      throw cause;
-    }
-  };
   async function protectedFunction(...args) {
-    if (state === "open") {
-      return fallback(...args);
-    } else if (state === "halfOpen") {
-      return mainWithEmit(...args).catch((cause) => {
-        openCircuit(cause);
-        return fallback(...args);
-      });
-    } else if (state === "closed") {
-      return mainWithEmit(...args).catch((cause) => {
+    if (state === "closed") {
+      return main(...args).catch((cause) => {
+        if (state === "disposed") throw cause;
         failureCause = cause;
         failureCount += errorIsFailure(cause) ? 1 : 0;
         if (failureCount >= failureThreshold) openCircuit(cause);
-        return fallback(...args);
+        return protectedFunction(...args);
       });
-    } else if (state === "disposed")
+    } else if (state === "open" || halfOpenPending) {
+      return fallback(...args);
+    } else if (state === "halfOpen") {
+      return (halfOpenPending = main(...args)).finally(() => halfOpenPending = void 0).then(
+        (result) => {
+          if (state !== "disposed") {
+            closeCircuit();
+            onClose?.();
+          }
+          return result;
+        },
+        (cause) => {
+          if (state === "disposed") throw cause;
+          openCircuit(cause);
+          return fallback(...args);
+        }
+      );
+    } else if (state === "disposed") {
       throw new Error("Circuit breaker has been disposed");
-    else throw assertNever(state);
+    } else {
+      throw void 0;
+    }
   }
   protectedFunction.dispose = () => {
-    events.removeAllListeners();
     closeCircuit();
     state = "disposed";
   };
+  protectedFunction.getLatestError = () => failureCause;
   protectedFunction.getState = () => state;
-  protectedFunction.off = (event, listener) => {
-    events.removeListener(event, listener);
-    return protectedFunction;
-  };
-  protectedFunction.on = (event, listener) => {
-    events.addListener(event, listener);
-    return protectedFunction;
-  };
   return protectedFunction;
 }
 

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../lib/util.ts","../lib/index.ts"],"sourcesContent":["export type AnyFn = (...args: any[]) => any\n\n/**\n * `[TypeScript]` For exhaustive checks in switch statements or if/else. Add\n * this check to `default` case or final `else` to ensure all possible values\n * have been handled. If a new value is added to the type, TypeScript will\n * throw an error and the editor will underline the `value`.\n */\nexport const assertNever = (value: never, message = \"Unexpected value\") =>\n\t/* v8 ignore next */\n\tnew TypeError(`${message}: ${value}`)\n","import { type AnyFn, assertNever } from \"./util.js\"\nimport EventEmitter from \"node:events\"\n\nexport type CircuitState = \"closed\" | \"disposed\" | \"halfOpen\" | \"open\"\n\nexport interface CircuitBreakerOptions<Args extends unknown[], Ret> {\n\t/**\n\t * Whether an error should be considered a failure that could trigger\n\t * the circuit breaker. Use this to prevent certain errors from\n\t * incrementing the failure count.\n\t * \n\t * @default () => true // Every error is considered a failure\n\t */\n\terrorIsFailure?: (error: unknown) => boolean\n\n\t/**\n\t * The number of failures before the circuit breaker opens.\n\t * \n\t * @default 1 // The first error opens the circuit\n\t */\n\tfailureThreshold?: number\n\n\t/**\n\t * If provided, then all rejected calls to `main` will be forwarded to\n\t * this function instead.\n\t * \n\t * @default undefined // No fallback, throws `CircuitOpenError`\n\t */\n\tfallback?: (...args: Args) => Promise<Ret>\n\n\t/**\n\t * The amount of time to wait before allowing a half-open state.\n\t * \n\t * @default 30_000 // 30 seconds\n\t */\n\tresetAfter?: number\n}\n\nexport interface EventMap {\n\tclose: []\n\topen: [cause: unknown]\n\treject: [cause: unknown]\n\tresolve: []\n}\n\nexport interface ProtectedFunction<Args extends unknown[], Ret> {\n\t(...args: Args): Promise<Ret>\n\n\t/** Free memory and stop timers */\n\tdispose(): void\n\n\t/** Get the current state of the circuit breaker */\n\tgetState(): CircuitState\n\n\t/** Remove a listener from the circuit breaker */\n\toff<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n\n\t/** Add a listener to the circuit breaker */\n\ton<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n}\n\nexport function createCircuitBreaker<Args extends unknown[], Ret>(\n\tmain: (...args: Args) => Promise<Ret>,\n\toptions: CircuitBreakerOptions<Args, Ret> = {}\n): ProtectedFunction<Args, Ret> {\n\tconst events = new EventEmitter<EventMap>()\n\tconst {\n\t\terrorIsFailure = () => true,\n\t\tfailureThreshold = 1,\n\t\tfallback = () => {\n\t\t\tconst cause = failureCause\n\t\t\tconst msg = cause instanceof Error ? cause.message : \"Unknown\"\n\t\t\tthrow new Error(`CircuitOpenError: ${msg}`, { cause })\n\t\t},\n\t\tresetAfter = 30_000,\n\t} = options\n\tlet state: CircuitState = \"closed\"\n\tlet failureCause: unknown | undefined = undefined\n\tlet failureCount = 0\n\tlet resetTimer: NodeJS.Timeout | undefined = undefined\n\n\t/**\n\t * Break the circuit and wait for a reset\n\t */\n\tfunction openCircuit(cause: unknown) {\n\t\tif (state === \"disposed\") return\n\t\tstate = \"open\"\n\t\tevents.emit(\"open\", cause)\n\t\tfailureCause = cause\n\t\tclearTimeout(resetTimer)\n\t\tresetTimer = setTimeout(() => (state = \"halfOpen\"), resetAfter)\n\t}\n\n\t/**\n\t * Restart the circuit and resume normal operation\n\t */\n\tfunction closeCircuit() {\n\t\tif (state === \"disposed\") return\n\t\tif (state === \"halfOpen\") events.emit(\"close\")\n\t\tstate = \"closed\"\n\t\tfailureCause = undefined\n\t\tfailureCount = 0\n\t\tclearTimeout(resetTimer)\n\t}\n\n\tconst mainWithEmit = async (...args: Args) => {\n\t\ttry {\n\t\t\tconst result = await main(...args)\n\t\t\tevents.emit(\"resolve\")\n\t\t\tcloseCircuit()\n\t\t\treturn result\n\t\t} catch (cause) {\n\t\t\tevents.emit(\"reject\", cause)\n\t\t\tthrow cause\n\t\t}\n\t}\n\n\t/**\n\t * Wrap calls to `main` with circuit breaker logic\n\t */\n\tasync function protectedFunction(...args: Args): Promise<Ret> {\n\t\t// Use the fallback while the circuit is open\n\t\tif (state === \"open\") {\n\t\t\treturn fallback(...args)\n\t\t}\n\n\t\t// While the circuit is half-open, try the main function once. If it\n\t\t// success, close the circuit and resume normal operation. If it fails,\n\t\t// re-open the circuit and run the fallback instead.\n\t\telse if (state === \"halfOpen\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\topenCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Normal operation when circuit is closed. If an error occurs, keep track\n\t\t// of the failure count and open the circuit if it exceeds the threshold.\n\t\telse if (state === \"closed\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\tfailureCause = cause\n\t\t\t\tfailureCount += errorIsFailure(cause) ? 1 : 0\n\t\t\t\tif (failureCount >= failureThreshold) openCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Shutting down...\n\t\telse if (state === \"disposed\")\n\t\t\tthrow new Error(\"Circuit breaker has been disposed\")\n\t\telse throw assertNever(state)\n\t}\n\n\tprotectedFunction.dispose = () => {\n\t\tevents.removeAllListeners()\n\t\tcloseCircuit()\n\t\tstate = \"disposed\"\n\t}\n\n\tprotectedFunction.getState = () => state\n\n\tprotectedFunction.off = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.removeListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\tprotectedFunction.on = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.addListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\treturn protectedFunction\n}\n"],"names":[],"mappings":";;;;AACO,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB;AAC/D;AACA,EAAE,IAAI,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC;;ACDM,SAAS,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE;AACzD,EAAE,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE;AACnC,EAAE,MAAM;AACR,IAAI,cAAc,GAAG,MAAM,IAAI;AAC/B,IAAI,gBAAgB,GAAG,CAAC;AACxB,IAAI,QAAQ,GAAG,MAAM;AACrB,MAAM,MAAM,KAAK,GAAG,YAAY;AAChC,MAAM,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS;AACpE,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;AAC5D,IAAI,CAAC;AACL,IAAI,UAAU,GAAG;AACjB,GAAG,GAAG,OAAO;AACb,EAAE,IAAI,KAAK,GAAG,QAAQ;AACtB,EAAE,IAAI,YAAY,GAAG,MAAM;AAC3B,EAAE,IAAI,YAAY,GAAG,CAAC;AACtB,EAAE,IAAI,UAAU,GAAG,MAAM;AACzB,EAAE,SAAS,WAAW,CAAC,KAAK,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,KAAK,GAAG,MAAM;AAClB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;AAC9B,IAAI,YAAY,GAAG,KAAK;AACxB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,IAAI,UAAU,GAAG,UAAU,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,UAAU,CAAC;AACjE,EAAE;AACF,EAAE,SAAS,YAAY,GAAG;AAC1B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,IAAI,KAAK,GAAG,QAAQ;AACpB,IAAI,YAAY,GAAG,MAAM;AACzB,IAAI,YAAY,GAAG,CAAC;AACpB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,EAAE;AACF,EAAE,MAAM,YAAY,GAAG,OAAO,GAAG,IAAI,KAAK;AAC1C,IAAI,IAAI;AACR,MAAM,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC;AACxC,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAC5B,MAAM,YAAY,EAAE;AACpB,MAAM,OAAO,MAAM;AACnB,IAAI,CAAC,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;AAClC,MAAM,MAAM,KAAK;AACjB,IAAI;AACJ,EAAE,CAAC;AACH,EAAE,eAAe,iBAAiB,CAAC,GAAG,IAAI,EAAE;AAC5C,IAAI,IAAI,KAAK,KAAK,MAAM,EAAE;AAC1B,MAAM,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAC9B,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,WAAW,CAAC,KAAK,CAAC;AAC1B,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,QAAQ,EAAE;AACnC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,YAAY,GAAG,KAAK;AAC5B,QAAQ,YAAY,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AACrD,QAAQ,IAAI,YAAY,IAAI,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC;AAChE,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU;AACnC,MAAM,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAC1D,SAAS,MAAM,WAAW,CAAC,KAAK,CAAC;AACjC,EAAE;AACF,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM;AACpC,IAAI,MAAM,CAAC,kBAAkB,EAAE;AAC/B,IAAI,YAAY,EAAE;AAClB,IAAI,KAAK,GAAG,UAAU;AACtB,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,QAAQ,GAAG,MAAM,KAAK;AAC1C,EAAE,iBAAiB,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC/C,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC;AAC1C,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC9C,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;AACvC,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,OAAO,iBAAiB;AAC1B;;;;"}
+{"version":3,"file":"index.cjs","sources":["../lib/index.ts"],"sourcesContent":["import { type AnyFn, assertNever } from \"./util.js\"\n\nexport type CircuitState = \"closed\" | \"disposed\" | \"halfOpen\" | \"open\"\n\nexport interface CircuitBreakerOptions<Fallback extends AnyFn = AnyFn> {\n\t/**\n\t * Whether an error should be considered a failure that could trigger\n\t * the circuit breaker. Use this to prevent certain errors from\n\t * incrementing the failure count.\n\t *\n\t * @default () => true // Every error is considered a failure\n\t */\n\terrorIsFailure?: (error: unknown) => boolean\n\n\t/**\n\t * The number of failures before the circuit breaker opens.\n\t *\n\t * @default 1 // The first error opens the circuit\n\t */\n\tfailureThreshold?: number\n\n\t/**\n\t * If provided, then all rejected calls to `main` will be forwarded to\n\t * this function instead.\n\t *\n\t * @default undefined // No fallback, errors are propagated\n\t */\n\tfallback?: Fallback\n\n\t/** Called when the circuit breaker is closed */\n\tonClose?: () => void\n\n\t/** Called when the circuit breaker is opened */\n\tonOpen?: (cause: unknown) => void\n\n\t/**\n\t * The amount of time to wait before allowing a half-open state.\n\t *\n\t * @default 30_000 // 30 seconds\n\t */\n\tresetAfter?: number\n}\n\nexport interface CircuitBreakerProtectedFn<\n\tRet = unknown,\n\tArgs extends unknown[] = never[]\n> {\n\t(...args: Args): Promise<Ret>\n\n\t/** Free memory and stop timers */\n\tdispose(): void\n\n\t/** Get the last error which triggered the circuit breaker */\n\tgetLatestError(): unknown | undefined\n\n\t/** Get the current state of the circuit breaker */\n\tgetState(): CircuitState\n}\n\nexport function createCircuitBreaker<\n\tRet,\n\tArgs extends unknown[],\n\tFallback extends AnyFn = (...args: Args) => Promise<Ret>\n>(\n\tmain: (...args: Args) => Promise<Ret>,\n\toptions: CircuitBreakerOptions<Fallback> = {}\n): CircuitBreakerProtectedFn<Ret, Args> {\n\tconst {\n\t\terrorIsFailure = () => true,\n\t\tfailureThreshold = 1,\n\t\tfallback = () => Promise.reject(failureCause),\n\t\tonClose,\n\t\tonOpen,\n\t\tresetAfter = 30_000,\n\t} = options\n\tlet halfOpenPending: Promise<unknown> | undefined\n\tlet state: CircuitState = \"closed\"\n\tlet failureCause: unknown | undefined = undefined\n\tlet failureCount = 0\n\tlet resetTimer: NodeJS.Timeout | undefined = undefined\n\n\t/**\n\t * Break the circuit and wait for a reset\n\t */\n\tfunction openCircuit(cause: unknown) {\n\t\tstate = \"open\"\n\t\tonOpen?.(cause)\n\t\tclearTimeout(resetTimer)\n\t\tresetTimer = setTimeout(() => (state = \"halfOpen\"), resetAfter)\n\t}\n\n\t/**\n\t * Reset the circuit and resume normal operation\n\t */\n\tfunction closeCircuit() {\n\t\tstate = \"closed\"\n\t\tfailureCause = undefined\n\t\tfailureCount = 0\n\t\tclearTimeout(resetTimer)\n\t}\n\n\t/**\n\t * Wrap calls to `main` with circuit breaker logic\n\t */\n\tasync function protectedFunction(...args: Args): Promise<Ret> {\n\t\t// Normal operation when circuit is closed. If an error occurs, keep track\n\t\t// of the failure count and open the circuit if it exceeds the threshold.\n\t\tif (state === \"closed\") {\n\t\t\treturn main(...args).catch((cause) => {\n\t\t\t\tif (state === \"disposed\") throw cause\n\t\t\t\tfailureCause = cause\n\t\t\t\tfailureCount += errorIsFailure(cause) ? 1 : 0\n\t\t\t\tif (failureCount >= failureThreshold) openCircuit(cause)\n\t\t\t\treturn protectedFunction(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Use the fallback while the circuit is open\n\t\telse if (state === \"open\" || halfOpenPending) {\n\t\t\treturn fallback(...args)\n\t\t}\n\n\t\t// While the circuit is half-open, try the main function once. If it\n\t\t// succeeds, close the circuit and resume normal operation. If it fails,\n\t\t// re-open the circuit and run the fallback instead.\n\t\telse if (state === \"halfOpen\") {\n\t\t\treturn (halfOpenPending = main(...args))\n\t\t\t\t.finally(() => (halfOpenPending = undefined))\n\t\t\t\t.then(\n\t\t\t\t\t(result) => {\n\t\t\t\t\t\tif (state !== \"disposed\") {\n\t\t\t\t\t\t\tcloseCircuit()\n\t\t\t\t\t\t\tonClose?.()\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn result\n\t\t\t\t\t},\n\t\t\t\t\t(cause) => {\n\t\t\t\t\t\tif (state === \"disposed\") throw cause\n\t\t\t\t\t\topenCircuit(cause)\n\t\t\t\t\t\treturn fallback(...args)\n\t\t\t\t\t}\n\t\t\t\t)\n\t\t}\n\n\t\t// Shutting down...\n\t\telse if (state === \"disposed\") {\n\t\t\tthrow new Error(\"Circuit breaker has been disposed\")\n\t\t\t/* v8 ignore next */\n\t\t}\n\n\t\t// exhaustive check\n\t\t/* v8 ignore next 5 */\n\t\telse {\n\t\t\tthrow process.env.NODE_ENV !== \"production\"\n\t\t\t\t? assertNever(state)\n\t\t\t\t: undefined\n\t\t}\n\t}\n\n\tprotectedFunction.dispose = () => {\n\t\tcloseCircuit()\n\t\tstate = \"disposed\"\n\t}\n\n\tprotectedFunction.getLatestError = () => failureCause\n\n\tprotectedFunction.getState = () => state\n\n\treturn protectedFunction\n}\n"],"names":[],"mappings":";;AAEO,SAAS,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE;AACzD,EAAE,MAAM;AACR,IAAI,cAAc,GAAG,MAAM,IAAI;AAC/B,IAAI,gBAAgB,GAAG,CAAC;AACxB,IAAI,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;AACjD,IAAI,OAAO;AACX,IAAI,MAAM;AACV,IAAI,UAAU,GAAG;AACjB,GAAG,GAAG,OAAO;AACb,EAAE,IAAI,eAAe;AACrB,EAAE,IAAI,KAAK,GAAG,QAAQ;AACtB,EAAE,IAAI,YAAY,GAAG,MAAM;AAC3B,EAAE,IAAI,YAAY,GAAG,CAAC;AACtB,EAAE,IAAI,UAAU,GAAG,MAAM;AACzB,EAAE,SAAS,WAAW,CAAC,KAAK,EAAE;AAC9B,IAAI,KAAK,GAAG,MAAM;AAClB,IAAI,MAAM,GAAG,KAAK,CAAC;AACnB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,IAAI,UAAU,GAAG,UAAU,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,UAAU,CAAC;AACjE,EAAE;AACF,EAAE,SAAS,YAAY,GAAG;AAC1B,IAAI,KAAK,GAAG,QAAQ;AACpB,IAAI,YAAY,GAAG,MAAM;AACzB,IAAI,YAAY,GAAG,CAAC;AACpB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,EAAE;AACF,EAAE,eAAe,iBAAiB,CAAC,GAAG,IAAI,EAAE;AAC5C,IAAI,IAAI,KAAK,KAAK,QAAQ,EAAE;AAC5B,MAAM,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AAC5C,QAAQ,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,KAAK;AAC7C,QAAQ,YAAY,GAAG,KAAK;AAC5B,QAAQ,YAAY,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AACrD,QAAQ,IAAI,YAAY,IAAI,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC;AAChE,QAAQ,OAAO,iBAAiB,CAAC,GAAG,IAAI,CAAC;AACzC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,MAAM,IAAI,eAAe,EAAE;AACpD,MAAM,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAC9B,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,CAAC,IAAI;AAC3F,QAAQ,CAAC,MAAM,KAAK;AACpB,UAAU,IAAI,KAAK,KAAK,UAAU,EAAE;AACpC,YAAY,YAAY,EAAE;AAC1B,YAAY,OAAO,IAAI;AACvB,UAAU;AACV,UAAU,OAAO,MAAM;AACvB,QAAQ,CAAC;AACT,QAAQ,CAAC,KAAK,KAAK;AACnB,UAAU,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,KAAK;AAC/C,UAAU,WAAW,CAAC,KAAK,CAAC;AAC5B,UAAU,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAClC,QAAQ;AACR,OAAO;AACP,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAC1D,IAAI,CAAC,MAAM;AACX,MAAM,MAAmC,MAAM;AAC/C,IAAI;AACJ,EAAE;AACF,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM;AACpC,IAAI,YAAY,EAAE;AAClB,IAAI,KAAK,GAAG,UAAU;AACtB,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,cAAc,GAAG,MAAM,YAAY;AACvD,EAAE,iBAAiB,CAAC,QAAQ,GAAG,MAAM,KAAK;AAC1C,EAAE,OAAO,iBAAiB;AAC1B;;;;"}

package/dist/index.d.cts

@@ -1,5 +1,7 @@
+type AnyFn = (...args: any[]) => any;
+
 type CircuitState = "closed" | "disposed" | "halfOpen" | "open";
-interface CircuitBreakerOptions<Args extends unknown[], Ret> {
+interface CircuitBreakerOptions<Fallback extends AnyFn = AnyFn> {
     /**
      * Whether an error should be considered a failure that could trigger
      * the circuit breaker. Use this to prevent certain errors from
@@ -18,9 +20,13 @@ interface CircuitBreakerOptions<Args extends unknown[], Ret> {
      * If provided, then all rejected calls to `main` will be forwarded to
      * this function instead.
      *
-     * @default undefined // No fallback, throws `CircuitOpenError`
+     * @default undefined // No fallback, errors are propagated
      */
-    fallback?: (...args: Args) => Promise<Ret>;
+    fallback?: Fallback;
+    /** Called when the circuit breaker is closed */
+    onClose?: () => void;
+    /** Called when the circuit breaker is opened */
+    onOpen?: (cause: unknown) => void;
     /**
      * The amount of time to wait before allowing a half-open state.
      *
@@ -28,24 +34,16 @@ interface CircuitBreakerOptions<Args extends unknown[], Ret> {
      */
     resetAfter?: number;
 }
-interface EventMap {
-    close: [];
-    open: [cause: unknown];
-    reject: [cause: unknown];
-    resolve: [];
-}
-interface ProtectedFunction<Args extends unknown[], Ret> {
+interface CircuitBreakerProtectedFn<Ret = unknown, Args extends unknown[] = never[]> {
     (...args: Args): Promise<Ret>;
     /** Free memory and stop timers */
     dispose(): void;
+    /** Get the last error which triggered the circuit breaker */
+    getLatestError(): unknown | undefined;
     /** Get the current state of the circuit breaker */
     getState(): CircuitState;
-    /** Remove a listener from the circuit breaker */
-    off<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
-    /** Add a listener to the circuit breaker */
-    on<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
 }
-declare function createCircuitBreaker<Args extends unknown[], Ret>(main: (...args: Args) => Promise<Ret>, options?: CircuitBreakerOptions<Args, Ret>): ProtectedFunction<Args, Ret>;
+declare function createCircuitBreaker<Ret, Args extends unknown[], Fallback extends AnyFn = (...args: Args) => Promise<Ret>>(main: (...args: Args) => Promise<Ret>, options?: CircuitBreakerOptions<Fallback>): CircuitBreakerProtectedFn<Ret, Args>;
 
 export { createCircuitBreaker };
-export type { CircuitBreakerOptions, CircuitState, EventMap, ProtectedFunction };
+export type { CircuitBreakerOptions, CircuitBreakerProtectedFn, CircuitState };

package/dist/index.d.mts

@@ -1,5 +1,7 @@
+type AnyFn = (...args: any[]) => any;
+
 type CircuitState = "closed" | "disposed" | "halfOpen" | "open";
-interface CircuitBreakerOptions<Args extends unknown[], Ret> {
+interface CircuitBreakerOptions<Fallback extends AnyFn = AnyFn> {
     /**
      * Whether an error should be considered a failure that could trigger
      * the circuit breaker. Use this to prevent certain errors from
@@ -18,9 +20,13 @@ interface CircuitBreakerOptions<Args extends unknown[], Ret> {
      * If provided, then all rejected calls to `main` will be forwarded to
      * this function instead.
      *
-     * @default undefined // No fallback, throws `CircuitOpenError`
+     * @default undefined // No fallback, errors are propagated
      */
-    fallback?: (...args: Args) => Promise<Ret>;
+    fallback?: Fallback;
+    /** Called when the circuit breaker is closed */
+    onClose?: () => void;
+    /** Called when the circuit breaker is opened */
+    onOpen?: (cause: unknown) => void;
     /**
      * The amount of time to wait before allowing a half-open state.
      *
@@ -28,24 +34,16 @@ interface CircuitBreakerOptions<Args extends unknown[], Ret> {
      */
     resetAfter?: number;
 }
-interface EventMap {
-    close: [];
-    open: [cause: unknown];
-    reject: [cause: unknown];
-    resolve: [];
-}
-interface ProtectedFunction<Args extends unknown[], Ret> {
+interface CircuitBreakerProtectedFn<Ret = unknown, Args extends unknown[] = never[]> {
     (...args: Args): Promise<Ret>;
     /** Free memory and stop timers */
     dispose(): void;
+    /** Get the last error which triggered the circuit breaker */
+    getLatestError(): unknown | undefined;
     /** Get the current state of the circuit breaker */
     getState(): CircuitState;
-    /** Remove a listener from the circuit breaker */
-    off<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
-    /** Add a listener to the circuit breaker */
-    on<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
 }
-declare function createCircuitBreaker<Args extends unknown[], Ret>(main: (...args: Args) => Promise<Ret>, options?: CircuitBreakerOptions<Args, Ret>): ProtectedFunction<Args, Ret>;
+declare function createCircuitBreaker<Ret, Args extends unknown[], Fallback extends AnyFn = (...args: Args) => Promise<Ret>>(main: (...args: Args) => Promise<Ret>, options?: CircuitBreakerOptions<Fallback>): CircuitBreakerProtectedFn<Ret, Args>;
 
 export { createCircuitBreaker };
-export type { CircuitBreakerOptions, CircuitState, EventMap, ProtectedFunction };
+export type { CircuitBreakerOptions, CircuitBreakerProtectedFn, CircuitState };

package/dist/index.mjs

@@ -1,86 +1,67 @@
-import EventEmitter from 'node:events';
-
-const assertNever = (value, message = "Unexpected value") => (
-  /* v8 ignore next */
-  new TypeError(`${message}: ${value}`)
-);
-
 function createCircuitBreaker(main, options = {}) {
-  const events = new EventEmitter();
   const {
     errorIsFailure = () => true,
     failureThreshold = 1,
-    fallback = () => {
-      const cause = failureCause;
-      const msg = cause instanceof Error ? cause.message : "Unknown";
-      throw new Error(`CircuitOpenError: ${msg}`, { cause });
-    },
+    fallback = () => Promise.reject(failureCause),
+    onClose,
+    onOpen,
     resetAfter = 3e4
   } = options;
+  let halfOpenPending;
   let state = "closed";
   let failureCause = void 0;
   let failureCount = 0;
   let resetTimer = void 0;
   function openCircuit(cause) {
-    if (state === "disposed") return;
     state = "open";
-    events.emit("open", cause);
-    failureCause = cause;
+    onOpen?.(cause);
     clearTimeout(resetTimer);
     resetTimer = setTimeout(() => state = "halfOpen", resetAfter);
   }
   function closeCircuit() {
-    if (state === "disposed") return;
-    if (state === "halfOpen") events.emit("close");
     state = "closed";
     failureCause = void 0;
     failureCount = 0;
     clearTimeout(resetTimer);
   }
-  const mainWithEmit = async (...args) => {
-    try {
-      const result = await main(...args);
-      events.emit("resolve");
-      closeCircuit();
-      return result;
-    } catch (cause) {
-      events.emit("reject", cause);
-      throw cause;
-    }
-  };
   async function protectedFunction(...args) {
-    if (state === "open") {
-      return fallback(...args);
-    } else if (state === "halfOpen") {
-      return mainWithEmit(...args).catch((cause) => {
-        openCircuit(cause);
-        return fallback(...args);
-      });
-    } else if (state === "closed") {
-      return mainWithEmit(...args).catch((cause) => {
+    if (state === "closed") {
+      return main(...args).catch((cause) => {
+        if (state === "disposed") throw cause;
         failureCause = cause;
         failureCount += errorIsFailure(cause) ? 1 : 0;
         if (failureCount >= failureThreshold) openCircuit(cause);
-        return fallback(...args);
+        return protectedFunction(...args);
       });
-    } else if (state === "disposed")
+    } else if (state === "open" || halfOpenPending) {
+      return fallback(...args);
+    } else if (state === "halfOpen") {
+      return (halfOpenPending = main(...args)).finally(() => halfOpenPending = void 0).then(
+        (result) => {
+          if (state !== "disposed") {
+            closeCircuit();
+            onClose?.();
+          }
+          return result;
+        },
+        (cause) => {
+          if (state === "disposed") throw cause;
+          openCircuit(cause);
+          return fallback(...args);
+        }
+      );
+    } else if (state === "disposed") {
       throw new Error("Circuit breaker has been disposed");
-    else throw assertNever(state);
+    } else {
+      throw void 0;
+    }
   }
   protectedFunction.dispose = () => {
-    events.removeAllListeners();
     closeCircuit();
     state = "disposed";
   };
+  protectedFunction.getLatestError = () => failureCause;
   protectedFunction.getState = () => state;
-  protectedFunction.off = (event, listener) => {
-    events.removeListener(event, listener);
-    return protectedFunction;
-  };
-  protectedFunction.on = (event, listener) => {
-    events.addListener(event, listener);
-    return protectedFunction;
-  };
   return protectedFunction;
 }
 

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../lib/util.ts","../lib/index.ts"],"sourcesContent":["export type AnyFn = (...args: any[]) => any\n\n/**\n * `[TypeScript]` For exhaustive checks in switch statements or if/else. Add\n * this check to `default` case or final `else` to ensure all possible values\n * have been handled. If a new value is added to the type, TypeScript will\n * throw an error and the editor will underline the `value`.\n */\nexport const assertNever = (value: never, message = \"Unexpected value\") =>\n\t/* v8 ignore next */\n\tnew TypeError(`${message}: ${value}`)\n","import { type AnyFn, assertNever } from \"./util.js\"\nimport EventEmitter from \"node:events\"\n\nexport type CircuitState = \"closed\" | \"disposed\" | \"halfOpen\" | \"open\"\n\nexport interface CircuitBreakerOptions<Args extends unknown[], Ret> {\n\t/**\n\t * Whether an error should be considered a failure that could trigger\n\t * the circuit breaker. Use this to prevent certain errors from\n\t * incrementing the failure count.\n\t * \n\t * @default () => true // Every error is considered a failure\n\t */\n\terrorIsFailure?: (error: unknown) => boolean\n\n\t/**\n\t * The number of failures before the circuit breaker opens.\n\t * \n\t * @default 1 // The first error opens the circuit\n\t */\n\tfailureThreshold?: number\n\n\t/**\n\t * If provided, then all rejected calls to `main` will be forwarded to\n\t * this function instead.\n\t * \n\t * @default undefined // No fallback, throws `CircuitOpenError`\n\t */\n\tfallback?: (...args: Args) => Promise<Ret>\n\n\t/**\n\t * The amount of time to wait before allowing a half-open state.\n\t * \n\t * @default 30_000 // 30 seconds\n\t */\n\tresetAfter?: number\n}\n\nexport interface EventMap {\n\tclose: []\n\topen: [cause: unknown]\n\treject: [cause: unknown]\n\tresolve: []\n}\n\nexport interface ProtectedFunction<Args extends unknown[], Ret> {\n\t(...args: Args): Promise<Ret>\n\n\t/** Free memory and stop timers */\n\tdispose(): void\n\n\t/** Get the current state of the circuit breaker */\n\tgetState(): CircuitState\n\n\t/** Remove a listener from the circuit breaker */\n\toff<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n\n\t/** Add a listener to the circuit breaker */\n\ton<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n}\n\nexport function createCircuitBreaker<Args extends unknown[], Ret>(\n\tmain: (...args: Args) => Promise<Ret>,\n\toptions: CircuitBreakerOptions<Args, Ret> = {}\n): ProtectedFunction<Args, Ret> {\n\tconst events = new EventEmitter<EventMap>()\n\tconst {\n\t\terrorIsFailure = () => true,\n\t\tfailureThreshold = 1,\n\t\tfallback = () => {\n\t\t\tconst cause = failureCause\n\t\t\tconst msg = cause instanceof Error ? cause.message : \"Unknown\"\n\t\t\tthrow new Error(`CircuitOpenError: ${msg}`, { cause })\n\t\t},\n\t\tresetAfter = 30_000,\n\t} = options\n\tlet state: CircuitState = \"closed\"\n\tlet failureCause: unknown | undefined = undefined\n\tlet failureCount = 0\n\tlet resetTimer: NodeJS.Timeout | undefined = undefined\n\n\t/**\n\t * Break the circuit and wait for a reset\n\t */\n\tfunction openCircuit(cause: unknown) {\n\t\tif (state === \"disposed\") return\n\t\tstate = \"open\"\n\t\tevents.emit(\"open\", cause)\n\t\tfailureCause = cause\n\t\tclearTimeout(resetTimer)\n\t\tresetTimer = setTimeout(() => (state = \"halfOpen\"), resetAfter)\n\t}\n\n\t/**\n\t * Restart the circuit and resume normal operation\n\t */\n\tfunction closeCircuit() {\n\t\tif (state === \"disposed\") return\n\t\tif (state === \"halfOpen\") events.emit(\"close\")\n\t\tstate = \"closed\"\n\t\tfailureCause = undefined\n\t\tfailureCount = 0\n\t\tclearTimeout(resetTimer)\n\t}\n\n\tconst mainWithEmit = async (...args: Args) => {\n\t\ttry {\n\t\t\tconst result = await main(...args)\n\t\t\tevents.emit(\"resolve\")\n\t\t\tcloseCircuit()\n\t\t\treturn result\n\t\t} catch (cause) {\n\t\t\tevents.emit(\"reject\", cause)\n\t\t\tthrow cause\n\t\t}\n\t}\n\n\t/**\n\t * Wrap calls to `main` with circuit breaker logic\n\t */\n\tasync function protectedFunction(...args: Args): Promise<Ret> {\n\t\t// Use the fallback while the circuit is open\n\t\tif (state === \"open\") {\n\t\t\treturn fallback(...args)\n\t\t}\n\n\t\t// While the circuit is half-open, try the main function once. If it\n\t\t// success, close the circuit and resume normal operation. If it fails,\n\t\t// re-open the circuit and run the fallback instead.\n\t\telse if (state === \"halfOpen\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\topenCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Normal operation when circuit is closed. If an error occurs, keep track\n\t\t// of the failure count and open the circuit if it exceeds the threshold.\n\t\telse if (state === \"closed\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\tfailureCause = cause\n\t\t\t\tfailureCount += errorIsFailure(cause) ? 1 : 0\n\t\t\t\tif (failureCount >= failureThreshold) openCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Shutting down...\n\t\telse if (state === \"disposed\")\n\t\t\tthrow new Error(\"Circuit breaker has been disposed\")\n\t\telse throw assertNever(state)\n\t}\n\n\tprotectedFunction.dispose = () => {\n\t\tevents.removeAllListeners()\n\t\tcloseCircuit()\n\t\tstate = \"disposed\"\n\t}\n\n\tprotectedFunction.getState = () => state\n\n\tprotectedFunction.off = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.removeListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\tprotectedFunction.on = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.addListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\treturn protectedFunction\n}\n"],"names":[],"mappings":";;AACO,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB;AAC/D;AACA,EAAE,IAAI,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC;;ACDM,SAAS,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE;AACzD,EAAE,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE;AACnC,EAAE,MAAM;AACR,IAAI,cAAc,GAAG,MAAM,IAAI;AAC/B,IAAI,gBAAgB,GAAG,CAAC;AACxB,IAAI,QAAQ,GAAG,MAAM;AACrB,MAAM,MAAM,KAAK,GAAG,YAAY;AAChC,MAAM,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS;AACpE,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;AAC5D,IAAI,CAAC;AACL,IAAI,UAAU,GAAG;AACjB,GAAG,GAAG,OAAO;AACb,EAAE,IAAI,KAAK,GAAG,QAAQ;AACtB,EAAE,IAAI,YAAY,GAAG,MAAM;AAC3B,EAAE,IAAI,YAAY,GAAG,CAAC;AACtB,EAAE,IAAI,UAAU,GAAG,MAAM;AACzB,EAAE,SAAS,WAAW,CAAC,KAAK,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,KAAK,GAAG,MAAM;AAClB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;AAC9B,IAAI,YAAY,GAAG,KAAK;AACxB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,IAAI,UAAU,GAAG,UAAU,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,UAAU,CAAC;AACjE,EAAE;AACF,EAAE,SAAS,YAAY,GAAG;AAC1B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,IAAI,KAAK,GAAG,QAAQ;AACpB,IAAI,YAAY,GAAG,MAAM;AACzB,IAAI,YAAY,GAAG,CAAC;AACpB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,EAAE;AACF,EAAE,MAAM,YAAY,GAAG,OAAO,GAAG,IAAI,KAAK;AAC1C,IAAI,IAAI;AACR,MAAM,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC;AACxC,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAC5B,MAAM,YAAY,EAAE;AACpB,MAAM,OAAO,MAAM;AACnB,IAAI,CAAC,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;AAClC,MAAM,MAAM,KAAK;AACjB,IAAI;AACJ,EAAE,CAAC;AACH,EAAE,eAAe,iBAAiB,CAAC,GAAG,IAAI,EAAE;AAC5C,IAAI,IAAI,KAAK,KAAK,MAAM,EAAE;AAC1B,MAAM,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAC9B,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,WAAW,CAAC,KAAK,CAAC;AAC1B,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,QAAQ,EAAE;AACnC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,YAAY,GAAG,KAAK;AAC5B,QAAQ,YAAY,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AACrD,QAAQ,IAAI,YAAY,IAAI,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC;AAChE,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU;AACnC,MAAM,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAC1D,SAAS,MAAM,WAAW,CAAC,KAAK,CAAC;AACjC,EAAE;AACF,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM;AACpC,IAAI,MAAM,CAAC,kBAAkB,EAAE;AAC/B,IAAI,YAAY,EAAE;AAClB,IAAI,KAAK,GAAG,UAAU;AACtB,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,QAAQ,GAAG,MAAM,KAAK;AAC1C,EAAE,iBAAiB,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC/C,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC;AAC1C,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC9C,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;AACvC,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,OAAO,iBAAiB;AAC1B;;;;"}
+{"version":3,"file":"index.mjs","sources":["../lib/index.ts"],"sourcesContent":["import { type AnyFn, assertNever } from \"./util.js\"\n\nexport type CircuitState = \"closed\" | \"disposed\" | \"halfOpen\" | \"open\"\n\nexport interface CircuitBreakerOptions<Fallback extends AnyFn = AnyFn> {\n\t/**\n\t * Whether an error should be considered a failure that could trigger\n\t * the circuit breaker. Use this to prevent certain errors from\n\t * incrementing the failure count.\n\t *\n\t * @default () => true // Every error is considered a failure\n\t */\n\terrorIsFailure?: (error: unknown) => boolean\n\n\t/**\n\t * The number of failures before the circuit breaker opens.\n\t *\n\t * @default 1 // The first error opens the circuit\n\t */\n\tfailureThreshold?: number\n\n\t/**\n\t * If provided, then all rejected calls to `main` will be forwarded to\n\t * this function instead.\n\t *\n\t * @default undefined // No fallback, errors are propagated\n\t */\n\tfallback?: Fallback\n\n\t/** Called when the circuit breaker is closed */\n\tonClose?: () => void\n\n\t/** Called when the circuit breaker is opened */\n\tonOpen?: (cause: unknown) => void\n\n\t/**\n\t * The amount of time to wait before allowing a half-open state.\n\t *\n\t * @default 30_000 // 30 seconds\n\t */\n\tresetAfter?: number\n}\n\nexport interface CircuitBreakerProtectedFn<\n\tRet = unknown,\n\tArgs extends unknown[] = never[]\n> {\n\t(...args: Args): Promise<Ret>\n\n\t/** Free memory and stop timers */\n\tdispose(): void\n\n\t/** Get the last error which triggered the circuit breaker */\n\tgetLatestError(): unknown | undefined\n\n\t/** Get the current state of the circuit breaker */\n\tgetState(): CircuitState\n}\n\nexport function createCircuitBreaker<\n\tRet,\n\tArgs extends unknown[],\n\tFallback extends AnyFn = (...args: Args) => Promise<Ret>\n>(\n\tmain: (...args: Args) => Promise<Ret>,\n\toptions: CircuitBreakerOptions<Fallback> = {}\n): CircuitBreakerProtectedFn<Ret, Args> {\n\tconst {\n\t\terrorIsFailure = () => true,\n\t\tfailureThreshold = 1,\n\t\tfallback = () => Promise.reject(failureCause),\n\t\tonClose,\n\t\tonOpen,\n\t\tresetAfter = 30_000,\n\t} = options\n\tlet halfOpenPending: Promise<unknown> | undefined\n\tlet state: CircuitState = \"closed\"\n\tlet failureCause: unknown | undefined = undefined\n\tlet failureCount = 0\n\tlet resetTimer: NodeJS.Timeout | undefined = undefined\n\n\t/**\n\t * Break the circuit and wait for a reset\n\t */\n\tfunction openCircuit(cause: unknown) {\n\t\tstate = \"open\"\n\t\tonOpen?.(cause)\n\t\tclearTimeout(resetTimer)\n\t\tresetTimer = setTimeout(() => (state = \"halfOpen\"), resetAfter)\n\t}\n\n\t/**\n\t * Reset the circuit and resume normal operation\n\t */\n\tfunction closeCircuit() {\n\t\tstate = \"closed\"\n\t\tfailureCause = undefined\n\t\tfailureCount = 0\n\t\tclearTimeout(resetTimer)\n\t}\n\n\t/**\n\t * Wrap calls to `main` with circuit breaker logic\n\t */\n\tasync function protectedFunction(...args: Args): Promise<Ret> {\n\t\t// Normal operation when circuit is closed. If an error occurs, keep track\n\t\t// of the failure count and open the circuit if it exceeds the threshold.\n\t\tif (state === \"closed\") {\n\t\t\treturn main(...args).catch((cause) => {\n\t\t\t\tif (state === \"disposed\") throw cause\n\t\t\t\tfailureCause = cause\n\t\t\t\tfailureCount += errorIsFailure(cause) ? 1 : 0\n\t\t\t\tif (failureCount >= failureThreshold) openCircuit(cause)\n\t\t\t\treturn protectedFunction(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Use the fallback while the circuit is open\n\t\telse if (state === \"open\" || halfOpenPending) {\n\t\t\treturn fallback(...args)\n\t\t}\n\n\t\t// While the circuit is half-open, try the main function once. If it\n\t\t// succeeds, close the circuit and resume normal operation. If it fails,\n\t\t// re-open the circuit and run the fallback instead.\n\t\telse if (state === \"halfOpen\") {\n\t\t\treturn (halfOpenPending = main(...args))\n\t\t\t\t.finally(() => (halfOpenPending = undefined))\n\t\t\t\t.then(\n\t\t\t\t\t(result) => {\n\t\t\t\t\t\tif (state !== \"disposed\") {\n\t\t\t\t\t\t\tcloseCircuit()\n\t\t\t\t\t\t\tonClose?.()\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn result\n\t\t\t\t\t},\n\t\t\t\t\t(cause) => {\n\t\t\t\t\t\tif (state === \"disposed\") throw cause\n\t\t\t\t\t\topenCircuit(cause)\n\t\t\t\t\t\treturn fallback(...args)\n\t\t\t\t\t}\n\t\t\t\t)\n\t\t}\n\n\t\t// Shutting down...\n\t\telse if (state === \"disposed\") {\n\t\t\tthrow new Error(\"Circuit breaker has been disposed\")\n\t\t\t/* v8 ignore next */\n\t\t}\n\n\t\t// exhaustive check\n\t\t/* v8 ignore next 5 */\n\t\telse {\n\t\t\tthrow process.env.NODE_ENV !== \"production\"\n\t\t\t\t? assertNever(state)\n\t\t\t\t: undefined\n\t\t}\n\t}\n\n\tprotectedFunction.dispose = () => {\n\t\tcloseCircuit()\n\t\tstate = \"disposed\"\n\t}\n\n\tprotectedFunction.getLatestError = () => failureCause\n\n\tprotectedFunction.getState = () => state\n\n\treturn protectedFunction\n}\n"],"names":[],"mappings":"AAEO,SAAS,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE;AACzD,EAAE,MAAM;AACR,IAAI,cAAc,GAAG,MAAM,IAAI;AAC/B,IAAI,gBAAgB,GAAG,CAAC;AACxB,IAAI,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;AACjD,IAAI,OAAO;AACX,IAAI,MAAM;AACV,IAAI,UAAU,GAAG;AACjB,GAAG,GAAG,OAAO;AACb,EAAE,IAAI,eAAe;AACrB,EAAE,IAAI,KAAK,GAAG,QAAQ;AACtB,EAAE,IAAI,YAAY,GAAG,MAAM;AAC3B,EAAE,IAAI,YAAY,GAAG,CAAC;AACtB,EAAE,IAAI,UAAU,GAAG,MAAM;AACzB,EAAE,SAAS,WAAW,CAAC,KAAK,EAAE;AAC9B,IAAI,KAAK,GAAG,MAAM;AAClB,IAAI,MAAM,GAAG,KAAK,CAAC;AACnB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,IAAI,UAAU,GAAG,UAAU,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,UAAU,CAAC;AACjE,EAAE;AACF,EAAE,SAAS,YAAY,GAAG;AAC1B,IAAI,KAAK,GAAG,QAAQ;AACpB,IAAI,YAAY,GAAG,MAAM;AACzB,IAAI,YAAY,GAAG,CAAC;AACpB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,EAAE;AACF,EAAE,eAAe,iBAAiB,CAAC,GAAG,IAAI,EAAE;AAC5C,IAAI,IAAI,KAAK,KAAK,QAAQ,EAAE;AAC5B,MAAM,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AAC5C,QAAQ,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,KAAK;AAC7C,QAAQ,YAAY,GAAG,KAAK;AAC5B,QAAQ,YAAY,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AACrD,QAAQ,IAAI,YAAY,IAAI,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC;AAChE,QAAQ,OAAO,iBAAiB,CAAC,GAAG,IAAI,CAAC;AACzC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,MAAM,IAAI,eAAe,EAAE;AACpD,MAAM,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAC9B,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,CAAC,IAAI;AAC3F,QAAQ,CAAC,MAAM,KAAK;AACpB,UAAU,IAAI,KAAK,KAAK,UAAU,EAAE;AACpC,YAAY,YAAY,EAAE;AAC1B,YAAY,OAAO,IAAI;AACvB,UAAU;AACV,UAAU,OAAO,MAAM;AACvB,QAAQ,CAAC;AACT,QAAQ,CAAC,KAAK,KAAK;AACnB,UAAU,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,KAAK;AAC/C,UAAU,WAAW,CAAC,KAAK,CAAC;AAC5B,UAAU,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAClC,QAAQ;AACR,OAAO;AACP,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAC1D,IAAI,CAAC,MAAM;AACX,MAAM,MAAmC,MAAM;AAC/C,IAAI;AACJ,EAAE;AACF,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM;AACpC,IAAI,YAAY,EAAE;AAClB,IAAI,KAAK,GAAG,UAAU;AACtB,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,cAAc,GAAG,MAAM,YAAY;AACvD,EAAE,iBAAiB,CAAC,QAAQ,GAAG,MAAM,KAAK;AAC1C,EAAE,OAAO,iBAAiB;AAC1B;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "breaker-box",
-	"version": "1.0.0",
+	"version": "2.0.0",
 	"description": "A zero-dependency circuit breaker implementation for Node.js",
 	"repository": "github:sirlancelot/breaker-box",
 	"main": "./dist/index.cjs",
@@ -20,14 +20,16 @@
 		"dist"
 	],
 	"scripts": {
-		"build": "pkgroll --clean-dist --src lib --target=node18 --sourcemap",
+		"build": "pkgroll --clean-dist --src lib --target=node18 --sourcemap --env.NODE_ENV=production",
 		"dev": "vitest",
 		"prepublishOnly": "npm run build",
 		"test": "vitest --run"
 	},
 	"keywords": [
 		"circuit-breaker",
-		"breaker-box"
+		"fallback",
+		"reliability",
+		"try-again"
 	],
 	"author": "Matthew Pietz <sirlancelot@gmail.com>",
 	"license": "ISC",