🏷️ move typings (#69)

Author: kuitos

README.md

@@ -116,6 +116,20 @@ http.get('/users', { useCache: true }); // make the request cacheable(real http
 http.get('/users', { useCache: true }); // use the response cache from previous request
 ```
 
+##### custom cache typing
+
+Note that if you are using custom cache flag and typescript, you may need to add the typing declaration like below:
+
+```ts
+import { ICacheLike } from 'axios-extensions';
+declare module 'axios' {
+  interface AxiosRequestConfig {
+    // if your cacheFlag was setting to 'useCache'
+    useCache?: boolean | ICacheLike<any>;
+  }
+}
+```
+
 #### more advanced
 
 Besides configuring the request through the `cacheAdapterEnhancer`, we can enjoy more advanced features via configuring every individual request.

src/cacheAdapterEnhancer.ts

@@ -9,6 +9,13 @@ import LRUCache from 'lru-cache';
 import buildSortedURL from './utils/buildSortedURL';
 import isCacheLike from './utils/isCacheLike';
 
+declare module 'axios' {
+	interface AxiosRequestConfig {
+		forceUpdate?: boolean;
+		cache?: boolean | ICacheLike<any>;
+	}
+}
+
 const FIVE_MINUTES = 1000 * 60 * 5;
 const CAPACITY = 100;
 
@@ -37,7 +44,9 @@ export default function cacheAdapterEnhancer(adapter: AxiosAdapter, options: Opt
 	return config => {
 
 		const { url, method, params, paramsSerializer, forceUpdate } = config;
-		const useCache = (config[cacheFlag] !== void 0 && config[cacheFlag] !== null) ? config[cacheFlag] : enabledByDefault;
+		const useCache = ((config as any)[cacheFlag] !== void 0 && (config as any)[cacheFlag] !== null)
+			? (config as any)[cacheFlag]
+			: enabledByDefault;
 
 		if (method === 'get' && useCache) {
 

src/index.ts

@@ -5,12 +5,13 @@
  */
 
 import Cache from 'lru-cache';
-import cacheAdapterEnhancer from './cacheAdapterEnhancer';
+import cacheAdapterEnhancer, { ICacheLike } from './cacheAdapterEnhancer';
 import retryAdapterEnhancer from './retryAdapterEnhancer';
 import throttleAdapterEnhancer from './throttleAdapterEnhancer';
 
 export {
 	Cache,
+	ICacheLike,
 	cacheAdapterEnhancer,
 	throttleAdapterEnhancer,
 	retryAdapterEnhancer,

src/retryAdapterEnhancer.ts

@@ -5,6 +5,12 @@
 
 import { AxiosAdapter, AxiosResponse } from 'axios';
 
+declare module 'axios' {
+	interface AxiosRequestConfig {
+		retryTimes?: number;
+	}
+}
+
 export type Options = {
 	times?: number;
 };