Update JSDocs

MetaMask · Jan 7, 2025 · 627b096 · 627b096
1 parent 65b8bcc
commit 627b096
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/packages/controller-utils/src/create-service-policy.ts b/packages/controller-utils/src/create-service-policy.ts
@@ -91,12 +91,18 @@ export const DEFAULT_DEGRADED_THRESHOLD = 5_000;
  * ``` ts
  * class Service {
  *   constructor() {
- *     this.#policy = createServicePolicy();
+ *     this.#policy = createServicePolicy({
+ *       maxRetries: 3,
+ *       maxConsecutiveFailures: 3,
+ *       circuitBreakDuration: 5000,
+ *       degradedThreshold: 2000,
+ *     });
  *   }
  *
  *   async fetch() {
- *     this.#policy.execute(async () => {
- *       // ...
+ *     return await this.#policy.execute(async () => {
+ *       const response = await fetch('https://some/url');
+ *       return await response.json();
  *     });
  *   }
  * }