xframelib/dist/utils/AxiosHelper.d.ts

The accumulated front-end development foundation library originates from projects and serves projects.

import { ResponseType } from 'axios';
/**
 * Get服务请求
 * @param apiUrl API接口路径
 * @param baseUrl 基础服务路径
 * @param _params 参数
 * @param headers headers参数
 * @param responseType 响应类型,默认为json
 * @param cancelToken  取消标识
 * @param timeoutMS 超时时间-毫秒
 * @returns 返回Promise对象
 */
declare function requestGet(apiUrl: string, baseUrl?: string, _params?: any, headers?: any, responseType?: ResponseType, cancelToken?: any, timeoutMS?: number): Promise<any>;
/**
 * Post服务请求-FormData
 * @param apiUrl API接口路径
 * @param baseUrl 基础服务路径
 * @param _params 参数
 * @param headers headers参数
 * @param responseType 返回类型，默认为json
 * @param timeoutMS  超时时间，默认为60000毫秒
 * @returns 返回Promise对象
 */
declare function requestPost(apiUrl: string, baseUrl?: string, _bodyFormParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType, timeoutMS?: number): Promise<any>;
/**
 * Post服务请求-Body方式
 * @param apiUrl API接口路径
 * @param baseUrl 基础服务路径
 * @param _bodyParams body相关参数
 * @param _queryParams  url的相关参数
 * @param headers 头相关参数
 * @param responseType 返回类型，默认为json
 * @param timeoutMS  超时时间，默认为60000毫秒
 * @returns
 */
declare function requestPostBody(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType, timeoutMS?: number): Promise<any>;
/**
 * 业务服务Get请求、请求网站下资源、http完整请求
 * @param url public下资源相对路径
 * @param _params 参数
 * @param isForceAPI 是否强制为API请求，默认false
 * @returns 返回Promise对象
 */
declare function get(url: string, _params?: any, isForceAPI?: boolean): Promise<any>;
/**
 * 业务服务Post请求
 * @param apiUrl API接口路径
 * @param _params 参数
 * @returns 返回Promise对象
 */
declare function post(apiUrl: string, _params?: any): Promise<any>;
/**
 * 独立的外部Get请求（无token验证信息）
 * @param fullRequestURL 完整请求路径
 * @param _params 请求参数
 * @returns  返回Promise对象
 * @deprecated 使用get方法替代，日后删除
 */
declare function getData(fullRequestURL: string, _params?: any): Promise<any>;
/**
 *  下载网站或完整路径的文件（二进制、文本）
 * @param url 网站相对路径或完整路径
 * @param fileName 文件名（默认为空，从URL里截取）
 * @param _params get请求参数
 * @returns
 */
declare function getDownload(url: string, fileName?: string, _params?: any): void;
export { get, post, requestPost, requestGet, getData, requestPostBody, getDownload };
export type { ResponseType };