Add retryable description

GetStream · Aug 7, 2023 · 9638d7e · 9638d7e
1 parent f6cab8b
commit 9638d7e
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/client/src/helpers/runWithRetry.ts b/packages/client/src/helpers/runWithRetry.ts
@@ -32,7 +32,7 @@ export class RetryError extends Error {
 }
 
 /**
- * Function which wraps asynchronous functions with error handler which checks whether response with code `200`
+ * Function which wraps asynchronous RPC methods with error handler which checks whether response with code `200`
  * holds error data, if it does, it throws `RpcError` to prevent false positives for `runWithRetry` retry handler.
  */
 export const handleFalsePositiveResponse = <
@@ -158,6 +158,9 @@ export const RetryPreset = {
   }),
 } as const;
 
+/**
+ * `runWithRetry` wrapper with pre-defined strategies (`RetryPreset`) and built in `handleFalsePositiveResponse` for RPC methods.
+ */
 export const retryable = <
   T extends FunctionToRetry,
   E extends keyof typeof RetryPreset,