st-common-req/lib/index.d.ts

Small Tail 前端通用请求库

import { ResType as _ResType } from './res/types/res-type.ts';
export declare const JsonHeaderNameConst: {
    IS_JSON_STRINGIFY: string;
};
export declare const reqByFetch: ({ url, jsonParse, config }: {
    url: string | URL | Request;
    jsonParse?: boolean;
    config?: RequestInit;
}) => Promise<any>;
export declare const genGetDataByReqHandler: <T>({ getDataApi, setData, setLoading, funThrottleTime, }: {
    getDataApi: (filters?: Record<string, any>) => Promise<_ResType>;
    setData: (data: T) => Promise<void>;
    setLoading?: (value: boolean) => void;
    funThrottleTime?: number;
}) => (filters?: Record<string, any>) => Promise<_ResType>;
import * as _resErrResCodeDescConst from './res/consts/err-res-code-desc-const.ts';
export declare const ErrResCodeDescConst: {
    readonly 400: "错误请求";
    readonly 401: "未授权，请登录";
    readonly 403: "禁止访问";
    readonly 404: "请求地址出错，未找到该资源";
    readonly 405: "请求方法未允许";
    readonly 408: "请求超时";
    readonly 500: "服务器端出错";
    readonly 501: "网络未实现";
    readonly 502: "网络错误";
    readonly 503: "服务不可用";
    readonly 504: "网络超时";
    readonly 505: "HTTP 版本不支持该请求";
};
export type ErrResCodeDescKey = _resErrResCodeDescConst.ErrResCodeDescKey;
import * as _resErrResTipConst from './res/consts/err-res-tip-const.ts';
export declare const ErrResTipConst: {
    readonly TIMEOUT: "请求超时，请重新尝试";
    readonly CONNECT_FAILED: "连接服务器失败，请稍后再试";
};
export type ErrResTipKey = _resErrResTipConst.ErrResTipKey;
export declare const ResStatusConst: {
    SUCCESS: {
        status: boolean;
        message: string;
    };
    FAIL: {
        status: boolean;
        message: string;
    };
};
export declare const ResObjPropNameConst: {
    readonly STATUS: "status";
    readonly MESSAGE: "message";
    readonly DATA: "data";
    readonly IS_ENCRYPT: "isEncrypt";
    readonly IS_JSON_STRINGIFY: "isJsonStringify";
};
export type ResType = _ResType;
export declare const genRes: ({ status, message, data, isEncrypt, isJsonStringify, }: {
    status?: boolean;
    message?: string;
    data?: any;
    isEncrypt?: boolean;
    isJsonStringify?: boolean;
}) => _ResType;
export declare const genSuccessRes: (message?: string, data?: any, isEncrypt?: boolean, isJsonStringify?: boolean) => _ResType;
export declare const genFailRes: (message?: string, data?: any, isEncrypt?: boolean, isJsonStringify?: boolean) => _ResType;
export * from './axios/types/axios-namespace.ts';
import * as _axiosGenReqUtilType from './axios/types/gen-req-util-type.ts';
export type GenAxiosReqUtilReturnType = _axiosGenReqUtilType.GenReqUtilReturnType;
export declare const addAxiosReqInterceptor: (axios: import('axios').AxiosInstance, preSendReqHandler?: (config: import('axios').InternalAxiosRequestConfig<any>) => void, rejectedHandler?: (error: import('axios').AxiosError) => any) => import('axios').AxiosInstance;
import * as _axiosResInterceptorUtil from './axios/utils/res-interceptor-util.ts';
export declare const addAxiosRespInterceptor: (axios: import('axios').AxiosInstance, fulfilledHandler?: (data: any, headers: _axiosResInterceptorUtil.FulfilledHandlerHeadersPropType, status: number) => any, rejectedHandler?: (message: string, error: import('axios').AxiosError) => any) => import('axios').AxiosInstance;
export type AxiosFulfilledHandlerHeadersPropType = _axiosResInterceptorUtil.FulfilledHandlerHeadersPropType;
export declare const setAxiosReqData: (config: import('axios').AxiosRequestConfig, data: any) => void;
export declare const getAxiosReqData: (config: import('axios').AxiosRequestConfig) => any;
export declare const genAxiosPostForm: (axios: import('axios').AxiosInstance) => _axiosGenReqUtilType.GenReqUtilReturnType;
export declare const genAxiosGet: (axios: import('axios').AxiosInstance) => _axiosGenReqUtilType.GenReqUtilReturnType;
export declare const genAxiosDel: (axios: import('axios').AxiosInstance) => _axiosGenReqUtilType.GenReqUtilReturnType;