aboutsummaryrefslogtreecommitdiffhomepage
path: root/node_modules/backo2/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/backo2/Readme.md')
-rw-r--r--node_modules/backo2/Readme.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/node_modules/backo2/Readme.md b/node_modules/backo2/Readme.md
new file mode 100644
index 0000000..0df2a39
--- /dev/null
+++ b/node_modules/backo2/Readme.md
@@ -0,0 +1,34 @@
+# backo
+
+ Simple exponential backoff because the others seem to have weird abstractions.
+
+## Installation
+
+```
+$ npm install backo
+```
+
+## Options
+
+ - `min` initial timeout in milliseconds [100]
+ - `max` max timeout [10000]
+ - `jitter` [0]
+ - `factor` [2]
+
+## Example
+
+```js
+var Backoff = require('backo');
+var backoff = new Backoff({ min: 100, max: 20000 });
+
+setTimeout(function(){
+ something.reconnect();
+}, backoff.duration());
+
+// later when something works
+backoff.reset()
+```
+
+# License
+
+ MIT