Add makeRetriable method

sindresorhus · sindresorhus · commit 1a81c1e2d257 · 2025-05-06T19:38:47.000+07:00
Fixes #61
diff --git a/index.d.ts b/index.d.ts
@@ -195,3 +195,20 @@ export default function pRetry<T>(
 	input: (attemptCount: number) => PromiseLike<T> | T,
 	options?: Options
 ): Promise<T>;
+
+/**
+Wrap a function so that each call is automatically retried on failure.
+
+@example
+```
+import {makeRetriable} from 'p-retry';
+
+const fetchWithRetry = makeRetriable(fetch, {retries: 5});
+
+const response = await fetchWithRetry('https://sindresorhus.com/unicorn');
+```
+*/
+export function makeRetriable<Arguments extends readonly unknown[], Result>(
+	function_: (...arguments_: Arguments) => PromiseLike<Result> | Result,
+	options?: Options
+): (...arguments_: Arguments) => Promise<Result>;
diff --git a/index.js b/index.js
@@ -135,3 +135,7 @@ export default async function pRetry(input, options = {}) {
 	// Should not reach here, but in case it does, throw an error
 	throw new Error('Retry attempts exhausted without throwing an error.');
 }
+
+export function makeRetriable(function_, options) {
+	return (...arguments_) => pRetry(() => function_(...arguments_), options);
+}
diff --git a/readme.md b/readme.md
@@ -193,6 +193,18 @@ Prevents retry timeouts from keeping the process alive.
 
 Only affects platforms with a `.unref()` method on timeouts, such as Node.js.
 
+### makeRetriable(function, options?)
+
+Wrap a function so that each call is automatically retried on failure.
+
+```js
+import {makeRetriable} from 'p-retry';
+
+const fetchWithRetry = makeRetriable(fetch, {retries: 5});
+
+const response = await fetchWithRetry('https://sindresorhus.com/unicorn');
+```
+
 ### AbortError(message)
 ### AbortError(error)
 
diff --git a/test.js b/test.js
@@ -4,7 +4,7 @@ import path from 'node:path';
 import {execa} from 'execa';
 import test from 'ava';
 import delay from 'delay';
-import pRetry, {AbortError} from './index.js';
+import pRetry, {makeRetriable, AbortError} from './index.js';
 
 const fixture = Symbol('fixture');
 const fixtureError = new Error('fixture');
@@ -697,3 +697,32 @@ main();
 		await fs.unlink(temporaryFile);
 	}
 });
+
+test('makeRetriable wraps and retries the function', async t => {
+	let callCount = 0;
+	const function_ = async (a, b) => {
+		callCount++;
+		if (callCount < 3) {
+			throw new Error('fail');
+		}
+
+		return a + b;
+	};
+
+	const retried = makeRetriable(function_, {retries: 5, minTimeout: 0});
+	const result = await retried(2, 3);
+	t.is(result, 5);
+	t.is(callCount, 3);
+});
+
+test('makeRetriable passes arguments and options', async t => {
+	let lastArguments;
+	const function_ = (...arguments_) => {
+		lastArguments = arguments_;
+		throw new Error('fail');
+	};
+
+	const retried = makeRetriable(function_, {retries: 1, minTimeout: 0});
+	await t.throwsAsync(() => retried('foo', 42));
+	t.deepEqual(lastArguments, ['foo', 42]);
+});

Original file line number	Diff line number	Diff line change
`@@ -135,3 +135,7 @@ export default async function pRetry(input, options = {}) {`
`135`	`135`	`// Should not reach here, but in case it does, throw an error`
`136`	`136`	`throw new Error('Retry attempts exhausted without throwing an error.');`
`137`	`137`	`}`
	`138`	`+`
	`139`	`+export function makeRetriable(function_, options) {`
	`140`	`+ return (...arguments_) => pRetry(() => function_(...arguments_), options);`
	`141`	`+}`