The documentation of onFailedAttempt(error) is incorrect and misleading.

[issuefiler]

This is the example code on the readme.md.

import pRetry from 'p-retry';

const run = async () => {
	const response = await fetch('https://sindresorhus.com/unicorn');

	if (!response.ok) {
		throw new Error(response.statusText);
	}

	return response.json();
};

const result = await pRetry(run, {
	onFailedAttempt: error => {
		console.log(`Attempt ${error.attemptNumber} failed. There are ${error.retriesLeft} retries left.`);
		// 1st request => Attempt 1 failed. There are 4 retries left.
		// 2nd request => Attempt 2 failed. There are 3 retries left.
		// …
	},
	retries: 5
});

console.log(result);

The comments say

// 1st request => Attempt 1 failed. There are 4 retries left.
// 2nd request => Attempt 2 failed. There are 3 retries left.

But this is neither true nor the actual output. When the 1^st attempt fails, there are still 5 retries left, because the retries does not count the first try as a re-try.

---

Fortunately this issue is not a bug of the code, but a mistake on the documentation.

The actual output for the retries of 5 is:

1. The 1^st attempt
2. onFailedAttempt({attemptNumber: 1, retriesLeft: 5})
3. The 2^nd attempt (the 1^st retry)
4. onFailedAttempt({attemptNumber: 2, retriesLeft: 4})
5. …
6. …
7. …
8. …
9. …
10. …
11. The 6^th attempt (the 5^th retry)
12. onFailedAttempt({attemptNumber: 6, retriesLeft: 0})