The type on BeforeRetryHook shouldn't contain any optional parameters

[alvis]

Describe the bug

In the typescript definition of BeforeRetryHook, error and retryCount are declared as optional, meaning they're potentially undefined. However, it's not true.

got/source/core/index.ts

Line 107 in 0d43f5f

export type BeforeRetryHook = (options: NormalizedOptions, error?: RequestError, retryCount?: number) => void | Promise<void>;

Actual behavior

error and retryCount contains the undefined type

Expected behavior

error and retryCount should be just simply RequestError and number

[alvis]

Sorry I have an oversight on the documentation. It's now clear to me that beforeRetry may be called with only the options parameter when a response is updated. For instant, updating an access token and retry.
See https://github.com/sindresorhus/got#hooksbeforeretry

The implementation can be found below. The hook is passed with only the options but not any error and retry count

got/source/as-promise/index.ts

Lines 107 to 110 in 1f132e8

	for (const hook of typedOptions.hooks.beforeRetry) {
	// eslint-disable-next-line no-await-in-loop
	await hook(typedOptions);
	}

[szmarczak]

There is no retryCount. ah wrong hook sorry

[szmarczak]

Yeah, but I think we could at least add retry count in that case.

[szmarczak]

Actually it's correct. It should be missing since it's not classic retrying. But I'm not sure whether we should call beforeRetry hook or not. Anyway, you can make a check and if retryCount is missing then you know it's from afterResponse.

[alvis]

My 2cents, but maybe it'll make the usage clearer by separating this special case to another hook in the next version? e.g. beforeRetryAfterResponseChange. beforeRetry for a classic automatic retry, and beforeRetryAfterResponseChange for a programmatic retry?

[szmarczak]

/cc @sindresorhus

[sindresorhus]

I agree the current situation could be improved, but I'm not sold on a beforeRetryAfterResponseChange hook either. I'm going to keep this issue open for alternative proposals on how to improve the situation.

[szmarczak]

Fixed in #1667