@iel/axios-ext
Version:
Extend extra functionality for axios.
30 lines (29 loc) • 1.18 kB
TypeScript
import { AxiosExtInstance } from './AxiosExt';
import { AxiosExtPlugin, AxiosExtPluginOnDestroyHook, AxiosExtPluginOnFinallyHook, AxiosExtPluginOnRequestHook, AxiosExtPluginOnResponseErrorHook, AxiosExtPluginOnResponseHook } from './PluginManager';
export declare type HelperCreateHook<T = any> = (callback: T) => void;
/**
* 请求时执行回调函数
*
* ***注意:在当前阶段设置 returnValue 为 Promise ,则提前返回数据并终止后续操作***
*/
export declare let onRequest: HelperCreateHook<AxiosExtPluginOnRequestHook>;
/**
* 响应时执行回调函数
*/
export declare let onResponse: HelperCreateHook<AxiosExtPluginOnResponseHook>;
/**
* 响应失败时执行回调函数
*/
export declare let onResponseError: HelperCreateHook<AxiosExtPluginOnResponseErrorHook>;
/**
* 最终结束时执行回调函数
*/
export declare let onFinally: HelperCreateHook<AxiosExtPluginOnFinallyHook>;
/**
* 销毁时执行回调函数
*/
export declare let onDestroy: HelperCreateHook<AxiosExtPluginOnDestroyHook>;
/**
* 安装插件
*/
export declare function setupPlugin(axiosExt: AxiosExtInstance, plugin: AxiosExtPlugin, options?: any): Promise<void>;