Skip to content

Commit

Permalink
Document the units of minTimeout and maxTimeout to be milliseconds.
Browse files Browse the repository at this point in the history
From other clues in the documentation, this appears to be the right unit.
  • Loading branch information
markstos committed Dec 30, 2013
1 parent 2ac8200 commit 62dee49
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -69,8 +69,8 @@ milliseconds. If `options` is an array, a copy of that array is returned.

* `retries`: The maximum amount of times to retry the operation. Default is `10`.
* `factor`: The exponential factor to use. Default is `2`.
* `minTimeout`: The amount of time before starting the first retry. Default is `1000`.
* `maxTimeout`: The maximum amount of time between two retries. Default is `Infinity`.
* `minTimeout`: The number of milliseconds before starting the first retry. Default is `1000`.
* `maxTimeout`: The maximum number of milliseconds between two retries. Default is `Infinity`.
* `randomize`: Randomizes the timeouts by multiplying with a factor between `1` to `2`. Default is `false`.

The formula used to calculate the individual timeouts is:
Expand Down

0 comments on commit 62dee49

Please sign in to comment.