fix: Deprecate config.instance

JustinBeckwith · Dec 20, 2023 · 3a7f247 · 3a7f247
1 parent e888e95
commit 3a7f247
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -27,6 +27,7 @@ export interface RetryConfig {
 
 	/**
 	 * The instance of the axios object to which the interceptor is attached.
+	 * @deprecated No longer needed.
 	 */
 	instance?: AxiosInstance;
 
@@ -179,7 +180,7 @@ async function onError(instance: AxiosInstance, error: AxiosError) {
 	config.retry = typeof config.retry === 'number' ? config.retry : 3;
 	config.retryDelay =
 		typeof config.retryDelay === 'number' ? config.retryDelay : 100;
-	config.instance = config.instance || instance;
+	instance = config.instance || instance;
 	config.backoffType = config.backoffType || 'exponential';
 	config.httpMethodsToRetry = normalizeArray(config.httpMethodsToRetry) || [
 		'GET',
@@ -296,7 +297,7 @@ async function onError(instance: AxiosInstance, error: AxiosError) {
 	return Promise.resolve()
 		.then(async () => onBackoffPromise)
 		.then(async () => onRetryAttemptPromise)
-		.then(async () => config.instance!.request(axiosError.config!));
+		.then(async () => instance.request(axiosError.config!));
 }
 
 /**

diff --git a/test/index.ts b/test/index.ts
@@ -34,7 +34,6 @@ describe('retry-axios', () => {
 			assert.strictEqual(config!.retry, 3, 'retry');
 			assert.strictEqual(config!.noResponseRetries, 2, 'noResponseRetries');
 			assert.strictEqual(config!.retryDelay, 100, 'retryDelay');
-			assert.strictEqual(config!.instance, axios, 'axios');
 			assert.strictEqual(config!.backoffType, 'exponential', 'backoffType');
 			assert.strictEqual(config!.checkRetryAfter, true);
 			assert.strictEqual(config!.maxRetryAfter, 60_000 * 5);