More docs updates

Author: ejsmith

.claude/settings.local.json

@@ -2,3 +2,5 @@
 /npm
 *.lcov
 /cov
+
+nul

.gitignore

@@ -15,28 +15,28 @@ hero:
       text: View on GitHub
       link: https://github.com/FoundatioFx/FetchClient
 features:
-  - icon: "\u26A1"
+  - icon: ⚡
     title: Typed JSON Helpers
     details: getJSON, postJSON, putJSON, patchJSON, deleteJSON with full TypeScript support.
-  - icon: "\uD83C\uDFAF"
+  - icon: 🎯
     title: Two API Styles
     details: Use simple functions or classes - your choice. Both have full access to all features.
-  - icon: "\uD83D\uDCBE"
+  - icon: 💾
     title: Response Caching
     details: TTL-based caching with cache keys and tags for grouped invalidation.
-  - icon: "\uD83E\uDDE9"
+  - icon: 🧩
     title: Middleware
     details: Intercept requests and responses for logging, auth, transforms, and more.
-  - icon: "\uD83D\uDEA6"
+  - icon: 🚦
     title: Rate Limiting
     details: Per-domain rate limits with automatic API header detection.
-  - icon: "\uD83D\uDEE1\uFE0F"
+  - icon: 🛡️
     title: Circuit Breaker
     details: Prevent cascading failures when services go down.
-  - icon: "\u23F1\uFE0F"
+  - icon: ⏱️
     title: Timeouts & Cancellation
     details: Request timeouts with native AbortSignal support.
-  - icon: "\uD83E\uDDEA"
+  - icon: 🧪
     title: Testing Built-in
     details: MockRegistry for mocking HTTP requests without network calls.
 ---

docs/index.md

@@ -19,8 +19,8 @@ export {
   CircuitBreaker,
   type CircuitBreakerOptions,
   type CircuitState,
-  type GroupCircuitBreakerOptions,
   groupByDomain as circuitBreakerGroupByDomain,
+  type GroupCircuitBreakerOptions,
 } from "./src/CircuitBreaker.ts";
 export {
   CircuitBreakerMiddleware,

mod.ts

@@ -7,11 +7,13 @@
 [![Discord](https://img.shields.io/discord/715744504891703319)](https://discord.gg/6HxgFCx)
 
 FetchClient is a tiny, typed wrapper around `fetch` with JSON helpers, caching,
-middleware, rate limiting, circuit breaker, timeouts, and friendly error handling.
+middleware, rate limiting, circuit breaker, timeouts, and friendly error
+handling.
 
 ## Features
 
-- **Typed JSON helpers** - `getJSON`, `postJSON`, `putJSON`, `patchJSON`, `deleteJSON`
+- **Typed JSON helpers** - `getJSON`, `postJSON`, `putJSON`, `patchJSON`,
+  `deleteJSON`
 - **Two API styles** - Functional (no classes) or class-based - your choice
 - **Response caching** - TTL-based caching with tags for grouped invalidation
 - **Middleware** - Intercept requests/responses for logging, auth, transforms
@@ -53,7 +55,9 @@ setBaseUrl("https://api.example.com");
 
 const client = getFetchClient();
 const { data: users } = await client.getJSON<User[]>("/users");
-const { data: created } = await client.postJSON<User>("/users", { name: "Alice" });
+const { data: created } = await client.postJSON<User>("/users", {
+  name: "Alice",
+});
 ```
 
 ### Class-Based API
@@ -65,7 +69,8 @@ const client = new FetchClient({ baseUrl: "https://api.example.com" });
 const { data } = await client.getJSON<User[]>("/users");
 ```
 
-All styles share the same configuration - the functional API wraps a [default provider](https://fetchclient.foundatio.dev/guide/provider#default-provider).
+All styles share the same configuration - the functional API wraps a
+[default provider](https://fetchclient.foundatio.dev/guide/provider#default-provider).
 
 ## Caching
 
@@ -111,8 +116,8 @@ import { FetchClientProvider } from "@foundatiofx/fetchclient";
 
 const provider = new FetchClientProvider();
 provider.useCircuitBreaker({
-  failureThreshold: 5,    // Open after 5 failures
-  openDurationMs: 30000,  // Stay open for 30 seconds
+  failureThreshold: 5, // Open after 5 failures
+  openDurationMs: 30000, // Stay open for 30 seconds
 });
 
 // When API fails repeatedly, circuit opens

readme.md

@@ -48,11 +48,16 @@ interface CircuitBreakerBucket {
   halfOpenAttempts: number; // Current concurrent requests in HALF_OPEN
 }
 
-type RequiredOptions = Required<
-  Omit<CircuitBreakerOptions, "groups" | "onOpen" | "onClose" | "onHalfOpen" | "onStateChange">
-> & {
-  onStateChange?: (from: CircuitState, to: CircuitState) => void;
-};
+type RequiredOptions =
+  & Required<
+    Omit<
+      CircuitBreakerOptions,
+      "groups" | "onOpen" | "onClose" | "onHalfOpen" | "onStateChange"
+    >
+  >
+  & {
+    onStateChange?: (from: CircuitState, to: CircuitState) => void;
+  };
 
 /**
  * Circuit breaker for preventing cascading failures.
@@ -117,16 +122,22 @@ export class CircuitBreaker {
   /**
    * Gets the effective options for a group.
    */
-  #getOptions(group: string): Required<Omit<GroupCircuitBreakerOptions, "onStateChange">> & {
+  #getOptions(
+    group: string,
+  ): Required<Omit<GroupCircuitBreakerOptions, "onStateChange">> & {
     onStateChange?: (from: CircuitState, to: CircuitState) => void;
   } {
     const groupOpts = this.#groupOptions.get(group);
     return {
-      failureThreshold: groupOpts?.failureThreshold ?? this.#options.failureThreshold,
-      failureWindowMs: groupOpts?.failureWindowMs ?? this.#options.failureWindowMs,
+      failureThreshold: groupOpts?.failureThreshold ??
+        this.#options.failureThreshold,
+      failureWindowMs: groupOpts?.failureWindowMs ??
+        this.#options.failureWindowMs,
       openDurationMs: groupOpts?.openDurationMs ?? this.#options.openDurationMs,
-      successThreshold: groupOpts?.successThreshold ?? this.#options.successThreshold,
-      halfOpenMaxAttempts: groupOpts?.halfOpenMaxAttempts ?? this.#options.halfOpenMaxAttempts,
+      successThreshold: groupOpts?.successThreshold ??
+        this.#options.successThreshold,
+      halfOpenMaxAttempts: groupOpts?.halfOpenMaxAttempts ??
+        this.#options.halfOpenMaxAttempts,
       onStateChange: groupOpts?.onStateChange ?? this.#options.onStateChange,
     };
   }
@@ -152,7 +163,11 @@ export class CircuitBreaker {
   /**
    * Transitions the circuit to a new state.
    */
-  #transitionTo(group: string, bucket: CircuitBreakerBucket, newState: CircuitState): void {
+  #transitionTo(
+    group: string,
+    bucket: CircuitBreakerBucket,
+    newState: CircuitState,
+  ): void {
     const oldState = bucket.state;
     if (oldState === newState) return;
 

src/CircuitBreaker.ts

@@ -260,7 +260,8 @@ export class FetchClientProvider {
    */
   public useCircuitBreaker(options?: CircuitBreakerMiddlewareOptions) {
     this.#circuitBreakerMiddleware = new CircuitBreakerMiddleware(options);
-    this.#circuitBreakerMiddlewareFunc = this.#circuitBreakerMiddleware.middleware();
+    this.#circuitBreakerMiddlewareFunc = this.#circuitBreakerMiddleware
+      .middleware();
     this.useMiddleware(this.#circuitBreakerMiddlewareFunc);
   }
 
@@ -276,7 +277,8 @@ export class FetchClientProvider {
       ...options,
       getGroupFunc: circuitBreakerGroupByDomain,
     });
-    this.#circuitBreakerMiddlewareFunc = this.#circuitBreakerMiddleware.middleware();
+    this.#circuitBreakerMiddlewareFunc = this.#circuitBreakerMiddleware
+      .middleware();
     this.useMiddleware(this.#circuitBreakerMiddlewareFunc);
   }
 

src/FetchClientProvider.ts

@@ -283,13 +283,19 @@ Deno.test("FetchClientProvider - useRateLimit enables rate limiting", async () =
   const client = provider.getFetchClient();
 
   // First two requests should succeed
-  const response1 = await client.getJSON("/api/data", { expectedStatusCodes: [429] });
-  const response2 = await client.getJSON("/api/data", { expectedStatusCodes: [429] });
+  const response1 = await client.getJSON("/api/data", {
+    expectedStatusCodes: [429],
+  });
+  const response2 = await client.getJSON("/api/data", {
+    expectedStatusCodes: [429],
+  });
   assertEquals(response1.status, 200);
   assertEquals(response2.status, 200);
 
   // Third request should be rate limited
-  const response3 = await client.getJSON("/api/data", { expectedStatusCodes: [429] });
+  const response3 = await client.getJSON("/api/data", {
+    expectedStatusCodes: [429],
+  });
   assertEquals(response3.status, 429);
 
   mocks.restore();
@@ -313,7 +319,9 @@ Deno.test("FetchClientProvider - removeRateLimit disables rate limiting", async
   await client.getJSON("/api/data", { expectedStatusCodes: [429] });
 
   // Second would be rate limited
-  const response2 = await client.getJSON("/api/data", { expectedStatusCodes: [429] });
+  const response2 = await client.getJSON("/api/data", {
+    expectedStatusCodes: [429],
+  });
   assertEquals(response2.status, 429);
 
   // Remove rate limiting
@@ -351,7 +359,9 @@ Deno.test("FetchClientProvider - useCircuitBreaker enables circuit breaker", asy
   assertEquals(provider.circuitBreaker!.getState("/api/data"), "OPEN");
 
   // Next request should return 503 without hitting the API
-  const response = await client.getJSON("/api/data", { expectedStatusCodes: [503] });
+  const response = await client.getJSON("/api/data", {
+    expectedStatusCodes: [503],
+  });
   assertEquals(response.status, 503);
   assertEquals(mocks.history.get.length, 2); // Only 2 requests made
 
@@ -381,7 +391,9 @@ Deno.test("FetchClientProvider - removeCircuitBreaker disables circuit breaker",
 
   // Now requests should go through (need new client)
   const client2 = provider.getFetchClient();
-  const response = await client2.getJSON("/api/data", { expectedStatusCodes: [500] });
+  const response = await client2.getJSON("/api/data", {
+    expectedStatusCodes: [500],
+  });
   assertEquals(response.status, 500); // Actual response, not 503
 
   mocks.restore();
@@ -466,15 +478,21 @@ Deno.test("FetchClientProvider - usePerDomainRateLimit groups by domain", async
   const client = provider.getFetchClient();
 
   // First request to domain1 succeeds
-  const r1 = await client.getJSON("https://domain1.com/api/data", { expectedStatusCodes: [429] });
+  const r1 = await client.getJSON("https://domain1.com/api/data", {
+    expectedStatusCodes: [429],
+  });
   assertEquals(r1.status, 200);
 
   // Second request to domain1 is rate limited
-  const r2 = await client.getJSON("https://domain1.com/api/other", { expectedStatusCodes: [429] });
+  const r2 = await client.getJSON("https://domain1.com/api/other", {
+    expectedStatusCodes: [429],
+  });
   assertEquals(r2.status, 429);
 
   // First request to domain2 succeeds (different domain)
-  const r3 = await client.getJSON("https://domain2.com/api/data", { expectedStatusCodes: [429] });
+  const r3 = await client.getJSON("https://domain2.com/api/data", {
+    expectedStatusCodes: [429],
+  });
   assertEquals(r3.status, 200);
 
   mocks.restore();
@@ -495,10 +513,14 @@ Deno.test("FetchClientProvider - usePerDomainCircuitBreaker isolates domains", a
   const client = provider.getFetchClient();
 
   // Fail on failing.com to open its circuit
-  await client.getJSON("https://failing.com/api", { expectedStatusCodes: [500, 503] });
+  await client.getJSON("https://failing.com/api", {
+    expectedStatusCodes: [500, 503],
+  });
 
   // failing.com circuit is open
-  const r1 = await client.getJSON("https://failing.com/api", { expectedStatusCodes: [503] });
+  const r1 = await client.getJSON("https://failing.com/api", {
+    expectedStatusCodes: [503],
+  });
   assertEquals(r1.status, 503);
 
   // working.com should still work (separate circuit)