Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Rename Readme.md to README.md so that it shows up on npmjs.org #11

Merged
merged 2 commits into from

2 participants

@markstos

No documentation for this project is showing up on it's official
npmjs.org listing:

https://npmjs.org/package/retry

Renaming Readme.md to README.md should fix that.

markstos added some commits
@markstos markstos Rename Readme.md to README.md so that it shows up on npmjs.org
No documentation for this project is showing up on it's official
npmjs.org listing:

    https://npmjs.org/package/retry

Renaming Readme.md to README.md should fix that.
2ac8200
@markstos markstos Document the units of minTimeout and maxTimeout to be milliseconds.
From other clues in the documentation, this appears to be the right unit.
62dee49
@tim-kos tim-kos merged commit 4bb360f into tim-kos:master
@tim-kos
Owner

Thank you! :+1:

@markstos

You are welcome. Any chance of releasing this soon? It's been several months and the documentation is still not showing up on npmjs.org.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Dec 30, 2013
  1. @markstos

    Rename Readme.md to README.md so that it shows up on npmjs.org

    markstos authored
    No documentation for this project is showing up on it's official
    npmjs.org listing:
    
        https://npmjs.org/package/retry
    
    Renaming Readme.md to README.md should fix that.
  2. @markstos

    Document the units of minTimeout and maxTimeout to be milliseconds.

    markstos authored
    From other clues in the documentation, this appears to be the right unit.
This page is out of date. Refresh to see the latest.
Showing with 2 additions and 2 deletions.
  1. +2 −2 Readme.md → README.md
View
4 Readme.md → README.md
@@ -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:
Something went wrong with that request. Please try again.