[@types/async-retry] has wrong type definition for onRetry

[yatki]

Hey onRetry type signature currently defined as:

(property) AsyncRetry.Options.onRetry?: (e: Error, attempt: number) => any.

However, in practice e object is what RetryFunction returns. If a fetch call returns a 404 response, response object is provided to onRetry function.

For instance if we stub the discoveryRequest method as below:

 oauthMock.discoveryRequest.mockRejectedValue(
    new Response(JSON.stringify({ randomError: 'randomError' }), {
      status: 404,
    })
  )

error object is the Response object that is returned from the discoveryRequest method.

import retry from 'async-retry'
import * as oauth from 'oauth4webapi'

// discoveryRequest
const discoveryResponse = await retry(
  async () => oauth.discoveryRequest(new URL(oidc.idpUrl)),
  {
    ...RETRY_OPTIONS,
    onRetry: (error, attempt) => {
      errorHandler(error, { errorTitle: 'Discovery request failed!', attempt })
    },
  }
)

Expected behaviour:
e: ReturnType<typeof fn> | Error

[typescript-bot]

Thanks for the discussion about "async-retry", some useful links for everyone:

• npm
• DT
• Related discussions

Pinging the DT module owners: @albertywu, @MeLlamoPablo, @rafsawicki, @BendingBender.