Skip to content

Commit 591e7f7

Browse files
authored
docs(token-manager): Correct documentation for jitterPercentage (redis#3153)
Correct the documentation for the jitterPercentage parameter to match the behavior in the code.
1 parent 5fb92bd commit 591e7f7

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

packages/client/lib/authx/token-manager.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ export interface RetryPolicy {
3333
backoffMultiplier: number;
3434

3535
/**
36-
* The percentage of jitter to apply to the delay.
36+
* The percentage range of jitter to apply to the delay.
37+
* The jitter will be evenly distributed between -jitterPercentage/2 and +jitterPercentage/2.
3738
* @example
38-
* A value of 0.1 will add or subtract up to 10% of the delay.
39+
* A value of 10 will add or subtract up to 5% of the delay (ranging from 95% to 105% of the original delay).
3940
*/
4041
jitterPercentage?: number;
4142

0 commit comments

Comments
 (0)