diff --git a/index.d.ts b/index.d.ts index be5b3bb..5bf9d81 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,27 +1,24 @@ -import * as axios from 'axios' +import * as axios from 'axios'; -interface IAxiosRetry { - ( - axios: axios.AxiosStatic | axios.AxiosInstance, - axiosRetryConfig?: IAxiosRetry.IAxiosRetryConfig - ): IAxiosRetry.IAxiosRetryReturn; +export = IAxiosRetry; +export as namespace axiosRetry; +declare const IAxiosRetry: IAxiosRetry.AxiosRetry; - isNetworkError(error: Error): boolean; - isRetryableError(error: Error): boolean; - isSafeRequestError(error: Error): boolean; - isIdempotentRequestError(error: Error): boolean; - isNetworkOrIdempotentRequestError(error: Error): boolean; - exponentialDelay(retryNumber?: number, error?: Error, delayFactor?: number): number; -} +declare namespace IAxiosRetry { + export interface AxiosRetry { + ( + axios: axios.AxiosStatic | axios.AxiosInstance, + axiosRetryConfig?: IAxiosRetryConfig + ): IAxiosRetryReturn; -export function isNetworkError(error: Error): boolean; -export function isRetryableError(error: Error): boolean; -export function isSafeRequestError(error: Error): boolean; -export function isIdempotentRequestError(error: Error): boolean; -export function isNetworkOrIdempotentRequestError(error: Error): boolean; -export function exponentialDelay(retryNumber?: number, error?: Error, delayFactor?: number): number; + isNetworkError(error: Error): boolean; + isRetryableError(error: Error): boolean; + isSafeRequestError(error: Error): boolean; + isIdempotentRequestError(error: Error): boolean; + isNetworkOrIdempotentRequestError(error: Error): boolean; + exponentialDelay(retryNumber?: number, error?: Error, delayFactor?: number): number; + } -declare namespace IAxiosRetry { export interface IAxiosRetryConfig { /** * The number of times to retry before failing @@ -29,33 +26,37 @@ declare namespace IAxiosRetry { * * @type {number} */ - retries?: number, + retries?: number; /** * Defines if the timeout should be reset between retries * default: false * * @type {boolean} */ - shouldResetTimeout?: boolean, + shouldResetTimeout?: boolean; /** * A callback to further control if a request should be retried. * default: it retries if it is a network error or a 5xx error on an idempotent request (GET, HEAD, OPTIONS, PUT or DELETE). * * @type {Function} */ - retryCondition?: (error: axios.AxiosError) => boolean | Promise, + retryCondition?: (error: axios.AxiosError) => boolean | Promise; /** * A callback to further control the delay between retry requests. By default there is no delay. * * @type {Function} */ - retryDelay?: (retryCount: number, error: axios.AxiosError) => number + retryDelay?: (retryCount: number, error: axios.AxiosError) => number; /** * A callback to get notified when a retry occurs, the number of times it has occurre, and the error * * @type {Function} */ - onRetry?: (retryCount: number, error: axios.AxiosError, requestConfig: axios.AxiosRequestConfig) => void + onRetry?: ( + retryCount: number, + error: axios.AxiosError, + requestConfig: axios.AxiosRequestConfig + ) => void; } export interface IAxiosRetryReturn { @@ -74,15 +75,8 @@ declare namespace IAxiosRetry { } } -declare const axiosRetry: IAxiosRetry; - -export type IAxiosRetryConfig = IAxiosRetry.IAxiosRetryConfig; -export type IAxiosRetryReturn = IAxiosRetry.IAxiosRetryReturn; - -export default axiosRetry; - declare module 'axios' { export interface AxiosRequestConfig { - 'axios-retry'?: IAxiosRetryConfig; + 'axios-retry'?: IAxiosRetry.IAxiosRetryConfig; } } diff --git a/package.json b/package.json index d2f38c7..a7a918c 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,7 @@ "bugs": { "url": "https://github.com/softonic/axios-retry/issues" }, - "typings": "./index.d.ts", + "types": "./index.d.ts", "main": "index.js", "module": "lib/esm/index.js", "exports": {