@zuiwoxing/posisi
Version:
一款基于typescript 前端控制组件,包括(IOC,AOP,Feign,Logger,Util等)
126 lines (125 loc) • 2.93 kB
TypeScript
import { FeignDecode } from "../feign/decode/FeignDecode";
import { FeignInterceptor } from "../feign/decode/FeignInterceptor";
/**
*@desc Posisi整体配置信息
*@author liudejian
*@date 2023-02-26 21:20
**/
export declare class PosisiConfig {
/**
* 开始加载-回调
*/
loadingStartCallback?: Function;
/**
* 加载结束-回调
*/
loadingEndCallback?: Function;
/**
* 跳转登录-回调
*/
gotoLoginCallback?: Function;
/**
* 用户自定义Decode
* 实现 FeignDecode
*/
userDecodeIns?: any;
/**
* 实例
*/
userInterceptorIns?: any;
baseUrl?: string;
/**
* 忽略异常(如果设置为true,当有异常时全局将不提示)
*/
ignoreGlobalError: boolean;
/**
* 通用请求头
*/
COMMON_HEADERS: {
"Access-Control-Allow-Origin": string;
Accept: string;
"Content-Type": string;
};
/**
* 排除URL后缀(正则匹配)
* @type {RegExp[]}
*/
EXCLUDE_URLS: RegExp[];
/**
* 请求超时时间 30 秒
*/
REQUEST_TIMEOUT: number;
/**
* 启用Loading
* @private
*/
loading: boolean;
isDebug: boolean;
/**
* 是否启用业务状态code
*/
enableCode: boolean;
/**
* 是否忽略全局异常处理
* @param isIgnoreError
*/
setIgnoreGlobalError(isIgnoreError: boolean): PosisiConfig;
/**
* 设置是否启用http状态code
* @param encodeCode
*/
setEnableCode(encodeCode: boolean): PosisiConfig;
getEnableCode(): boolean;
/**
* 启用DEBUG
* @param isDebug
*/
enableDebug(): PosisiConfig;
/**
* 禁用DEBUG
*/
disableDebug(): PosisiConfig;
/**
* 启用loading
*/
enableLoading(): PosisiConfig;
/**
* 关闭load
*/
disableLoading(): PosisiConfig;
/**
* 设置loadstart开始加载回调
* @param loadingStartCallback
*/
setLoadingStartCallback(loadingStartCallback?: Function): PosisiConfig;
/**
* 结束loading 时候回调
* @param loadingEndCallback
*/
setLoadingEndCallback(loadingEndCallback?: Function): PosisiConfig;
/**
* 设置基础URL
* @param baseUrl
*/
setBaseUrl(baseUrl: string): PosisiConfig;
/**
* this.setFeignDecode(DefaultFeignDecode)
* this.setFeignDecode(new DefaultFeignDecode())
* 设置用户自定义的解码器: 必须实现FeignDecode接口
* @param userDecode
*/
setFeignDecode(userDecodeIns: any): PosisiConfig;
/**
* 获取解码器
*/
getFeignDecode(): FeignDecode;
/**
* 设置拦截器
* @param userInterceptor
*/
setUserInterceptor(userInterceptorIns: any): PosisiConfig;
/**
* 获取用户自定义拦截器
*/
getUserInterceptor(): FeignInterceptor;
}