retryme - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

index.js

@@ -24,3 +24,3 @@ const Backo = require('backo');
 
-  debug('executing action function')
+  debug('executing action function');
   action(once(function next(err) {
@@ -38,2 +38,29 @@ if (!err || err && self.ignore(err)) return fn.apply(this, arguments);
 
+Retryme.prototype.async = function (asyncfn) {
+  return new Promise((fulfill, reject) => {
+    debug('Start retries with awaiting async attempt function');
+
+    this.attempt(
+      next => {
+        return asyncfn()
+          .then(body => {
+            next(null, body);
+          }, err => {
+            debug('error happens, gonna retry');
+
+            next(err);
+          });
+      }, (error, body) => {
+        if (error) {
+          debug('out of retries, will error out.');
+
+          return reject(error);
+        }
+
+        debug('retry succeeds');
+        fulfill(body);
+      });
+  });
+};
+
 Retryme.prototype._error = function _error(fn) {
@@ -58,1 +85,2 @@ const error = this.errors.pop();
 module.exports = Retryme;
+

package.json

 {
   "name": "retryme",
-  "version": "1.0.0",
-  "description": "",
+  "version": "1.1.0",
+  "description": "A more intuitive node-retry which behaves more like async.retry. Utilizes Backo under the hood for backoff.",
   "main": "index.js",
   "scripts": {
-    "test": "nyc mocha"
+    "lint:fix": "eslint -c .eslintrc --fix *.js test/**/*.test.js",
+    "pretest": "npm run lint:fix",
+    "test:mocha": "mocha test/*.test.js",
+    "test": "nyc --reporter=text --reporter=json-summary npm run test:mocha"
   },
+  "repository": {
+    "type": "git",
+    "url": "[e-mail]:jcrugzz/retryme.git"
+  },
   "keywords": [],
-  "author": "",
+  "author": "Jarrett Cruger <[e-mail]>",
   "license": "ISC",
@@ -19,6 +26,11 @@ "dependencies": {
   "devDependencies": {
-    "assume": "^1.5.1",
-    "mocha": "^3.5.0",
-    "nyc": "^11.1.0"
+    "assume": "^2.0.1",
+    "eslint": "^4.19.1",
+    "eslint-config-godaddy": "^2.1.0",
+    "eslint-config-godaddy-es5": "^2.1.0",
+    "eslint-plugin-json": "^1.2.0",
+    "eslint-plugin-mocha": "^4.12.1",
+    "mocha": "^5.1.1",
+    "nyc": "^11.8.0"
   }
 }

README.md

@@ -8,5 +8,10 @@ # retryme
 
+Retryme also supports `async/await` now for retrying async attempt functions.
+
 ## Usage
 
+### Regular usage
 
+Here's the example of how to use `retryme` in normal ways.
+
 ```js
@@ -28,3 +33,3 @@ var Retryme = require('retryme');
   if (err || res.statusCode !== 200) {
-    return next(err || new Error(`Invalid status code ${res.statusCode}));
+    return next(err || new Error(`Invalid status code ${res.statusCode}`));
   }
@@ -36,3 +41,2 @@ next(null, body);
 });
-
 ```
@@ -52,3 +56,3 @@
     // any 404 error here will no longer be retried due to the function above
-    return next(err || new Error(`Invalid status code ${res.statusCode}));
+    return next(err || new Error(`Invalid status code ${res.statusCode}`));
   }
@@ -64,2 +68,58 @@ next(null, body);
 
+### `Async/await` Support
+
+Retryme now supports `async/await` by providing `.async` function to retry async attempt functions.
+
+A simple example of how to use it is as follows:
+
+```js
+
+// example of calling the method for async functions returning Promises.
+const readFileAsync = require('util').promisify(require('fs').readFile);
+const Retryme = require('retryme');
+
+async function main() {
+  const op = new Retryme({
+    retries: 2,
+    min: 50,
+    max: 10000
+  }, some_ignore_function_if_exists);
+
+  // Wrap a simple file read with retries.
+  try {
+    const fileContent = await op.async(() => readFileAsync(__dirname + '/index.js'));
+  } catch(err) {
+    console.log('error after 2 attempts');
+    console.error(err);
+  }
+}
+
+// it supports async functions
+async function foo(bad) {
+  if (bad !== 'hola') return 'bar';
+  throw Error('what happened');
+}
+
+async function main() {
+  const op = new Retryme();
+  try {
+    const result = await op.async(() => foo('hello'));
+  } catch(err) {
+    console.error(err);
+  }
+}
+
+// it also supports thenables
+async function main() {
+  await op.async(() => {
+    return {
+      then: (f, r) => {
+        // real functionality happens here
+      }
+    };
+  });
+}
+
+```
+
 ## test
@@ -72,1 +132,2 @@
 [backo]: https://github.com/segmentio/backo
+

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8532

increased by69.42%

Number of package files

9

increased by50%

Lines of code

154

increased by85.54%

Number of low maintenance alerts

2

decreased by-33.33%

Number of lines in readme file

128

increased by91.04%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

8

increased by166.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes