@chriscdn/promise-retry 1.0.1 → 1.0.4

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "singleQuote": true
+}

package/README.md

@@ -1,6 +1,6 @@
 # @chriscdn/promise-retry
 
-Retry a function returning a rejected promise until it resolves or exceeds the maximum attempt count.
+Retry a function returning a promise until it resolves successfully or exceeds the maximum attempt count.
 
 ## Installing
 
@@ -16,42 +16,56 @@ Using yarn:
 $ yarn add @chriscdn/promise-retry
 ```
 
-## Example
+## Example 1 - Promises
 
 ```js
-const promiseRetry = require('@chriscdn/promise-reject')
+const promiseRetry = require('@chriscdn/promise-retry')
 
 function myFunction(attempt) {
-	return new Promise((resolve, reject) => {
-
-		// ... do something
-
-		if (allIsFine) {
-			resolve(<value>)
-		} else {
-			reject(<err>)
-		}
-	})
-
+  return new Promise((resolve, reject) => {
+    // ... do something
+
+    if (allIsFine) {
+      resolve(/* <value> */)
+    } else {
+      reject(/* <err> */)
+    }
+  })
 }
 
 const options = {
-	maxAttempts: 10,
-	timeout: 0
+  maxAttempts: 10,
+  retryDelay: 0,
 }
 
 // Call myFunction until a resolved promise is returned, but not more than 10 times (default is 10)
-promiseRetry(attempt => myFunction(attempt), options)
-	.then(value => {
-		// myFunction resolved within 10 attempts
-		// value is from the myFunction resolve call
-	})
-	.catch(err => {
-		// myFunction failed to return a resolved promise within 10 attempts
-		// err is the reject value from the last attempt
-	})
+promiseRetry((attempt) => myFunction(attempt), options)
+  .then((value) => {
+    // myFunction resolved within 10 attempts
+    // value is from the myFunction resolve call
+  })
+  .catch((err) => {
+    // myFunction failed to return a resolved promise within 10 attempts
+    // err is the reject value from the last attempt
+  })
+```
+
+## Example 2 - Async/Await
+
+```js
+const promiseRetry = require('@chriscdn/promise-retry')
+
+const results = await promiseRetry(
+  async (attempt) => {
+    // do something async in here
+  },
+  {
+    maxAttempts: 10,
+    retryDelay: 0,
+  }
+)
 ```
 
 ## License
 
-[MIT](LICENSE)
+[MIT](LICENSE)

package/lib/index.cjs.js

@@ -1,25 +1,25 @@
 'use strict';
 
 const defaultOptions = {
-	maxAttempts: 10,
-	milliseconds: 0
+  maxAttempts: 10,
+  retryDelay: 0,
 };
 
 function promiseRetry(func, options = defaultOptions, attempt = 1) {
+  const config = { ...defaultOptions, ...options };
 
-	const config = { ...defaultOptions, ...options };
-
-	return func(attempt)
-		.catch(err => {
-			if (attempt < config.maxAttempts) {
-				// return promiseRetry(func, options, attempt + 1)
-				return new Promise(resolve => {
-					setTimeout(() => resolve(promiseRetry(func, options, attempt + 1)), config.milliseconds);
-				})
-			} else {
-				throw err
-			}
-		})
+  return func(attempt).catch((err) => {
+    if (attempt < config.maxAttempts) {
+      return new Promise((resolve) => {
+        setTimeout(
+          () => resolve(promiseRetry(func, options, attempt + 1)),
+          config.retryDelay
+        );
+      })
+    } else {
+      throw err
+    }
+  })
 }
 
 module.exports = promiseRetry;

package/lib/index.es.js

@@ -1,25 +1,25 @@
 const defaultOptions = {
-	maxAttempts: 10,
-	milliseconds: 0
+  maxAttempts: 10,
+  retryDelay: 0,
 };
 
 function promiseRetry(func, options = defaultOptions, attempt = 1) {
+  const config = { ...defaultOptions, ...options };
 
-	const config = { ...defaultOptions, ...options };
-
-	return func(attempt)
-		.catch(err => {
-			if (attempt < config.maxAttempts) {
-				// return promiseRetry(func, options, attempt + 1)
-				return new Promise(resolve => {
-					setTimeout(() => resolve(promiseRetry(func, options, attempt + 1)), config.milliseconds);
-				})
-			} else {
-				throw err
-			}
-		})
+  return func(attempt).catch((err) => {
+    if (attempt < config.maxAttempts) {
+      return new Promise((resolve) => {
+        setTimeout(
+          () => resolve(promiseRetry(func, options, attempt + 1)),
+          config.retryDelay
+        );
+      })
+    } else {
+      throw err
+    }
+  })
 }
 
 var src = promiseRetry;
 
-export default src;
+export { src as default };

package/package.json

@@ -1,21 +1,21 @@
 {
-	"name": "@chriscdn/promise-retry",
-	"version": "1.0.1",
-	"description": "Retry a function returning a rejected promise until it resolves.",
-	"main": "lib/index.cjs.js",
-	"module": "lib/index.es.js",
-	"repository": "https://github.com/chriscdn/promise-retry",
-	"author": "Christopher Meyer <chris@schwiiz.org>",
-	"license": "MIT",
-	"scripts": {
-		"build": "rollup -c",
-		"watch": "rollup -c --watch"
-	},
-	"devDependencies": {
-		"@rollup/plugin-commonjs": "^15.1.0"
-	},
-	"keywords": [
-		"promise",
-		"retry"
-	]
+  "name": "@chriscdn/promise-retry",
+  "version": "1.0.4",
+  "description": "Retry a function returning a rejected promise until it resolves.",
+  "main": "lib/index.cjs.js",
+  "module": "lib/index.es.js",
+  "repository": "https://github.com/chriscdn/promise-retry",
+  "author": "Christopher Meyer <chris@schwiiz.org>",
+  "license": "MIT",
+  "scripts": {
+    "build": "rollup -c",
+    "watch": "rollup -c --watch"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^21.0.3"
+  },
+  "keywords": [
+    "promise",
+    "retry"
+  ]
 }

package/rollup.config.js

@@ -1,19 +1,24 @@
 import pkg from './package.json'
 import commonjs from '@rollup/plugin-commonjs'
 
-export default [{
-	input: 'src/index.js',
-	output: [{
-		file: pkg.main,
-		format: 'cjs'
-	}]
-}, {
-	input: 'src/index.js',
-	output: [{
-		file: pkg.module,
-		format: 'es'
-	}],
-	plugins: [
-		commonjs()
-	]
-}]
+export default [
+  {
+    input: 'src/index.js',
+    output: [
+      {
+        file: pkg.main,
+        format: 'cjs',
+      },
+    ],
+  },
+  {
+    input: 'src/index.js',
+    output: [
+      {
+        file: pkg.module,
+        format: 'es',
+      },
+    ],
+    plugins: [commonjs()],
+  },
+]

package/src/index.js

@@ -1,23 +1,23 @@
 const defaultOptions = {
-	maxAttempts: 10,
-	milliseconds: 0
+  maxAttempts: 10,
+  retryDelay: 0,
 }
 
 function promiseRetry(func, options = defaultOptions, attempt = 1) {
+  const config = { ...defaultOptions, ...options }
 
-	const config = { ...defaultOptions, ...options }
-
-	return func(attempt)
-		.catch(err => {
-			if (attempt < config.maxAttempts) {
-				// return promiseRetry(func, options, attempt + 1)
-				return new Promise(resolve => {
-					setTimeout(() => resolve(promiseRetry(func, options, attempt + 1)), config.milliseconds)
-				})
-			} else {
-				throw err
-			}
-		})
+  return func(attempt).catch((err) => {
+    if (attempt < config.maxAttempts) {
+      return new Promise((resolve) => {
+        setTimeout(
+          () => resolve(promiseRetry(func, options, attempt + 1)),
+          config.retryDelay
+        )
+      })
+    } else {
+      throw err
+    }
+  })
 }
 
-module.exports = promiseRetry
+module.exports = promiseRetry