Skip to content

Commit 1f1cd82

Browse files
committed
docs: add config doc block for retry config
1 parent 4a76cc3 commit 1f1cd82

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

packages/retry-middleware/src/configurations.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@ import { ExponentialBackOffStrategy } from "./defaultStrategy";
33

44
export namespace RetryConfig {
55
export interface Input {
6+
/**
7+
* The maximum number of times requests that encounter potentially transient failures should be retried
8+
*/
69
maxRetries?: number;
10+
/**
11+
* The strategy to retry the request. Using built-in exponential backoff strategy by default.
12+
*/
713
retryStrategy?: RetryStrategy;
814
}
915
export interface Resolved {

0 commit comments

Comments
 (0)