Norm Fetch使用文档

主题

NormAxios ​

NormAxios 是一个基于 Axios 实现的约定式请求类，它解决了多个后台服务，后台服务的数据结构可能不一致的问题。 ---> 详细教程

typescript
class NormAxios<TResponse extends Record<string, any> = Record<string, any>> {
  axiosInstance: AxiosInstance;

  axiosConfig: NormAxiosConfig<TResponse>;

  constructor(config: NormAxiosConfig<TResponse>);

  request<TData = any, TParams extends Record<string, any> = Record<string, any>>(config: AxiosRequestConfig<TParams>): Promise<ResponseContent<TData, TResponse>>;

  get<TData = any, TParams extends Record<string, any> = Record<string, any>>(url: string, params?: TParams, config?: AxiosRequestConfig<TParams>): Promise<ResponseContent<TData, TResponse>>;

  post<TData = any, TParams extends Record<string, any> = Record<string, any>>(url: string, data?: TParams, config?: AxiosRequestConfig<TParams>): Promise<ResponseContent<TData, TResponse>>;

  put<TData = any, TParams extends Record<string, any> = Record<string, any>>(url: string, data?: TParams, config?: AxiosRequestConfig<TParams>): Promise<ResponseContent<TData, TResponse>>;

  delete<TData = any, TParams extends Record<string, any> = Record<string, any>>(url: string, data?: TParams, config?: AxiosRequestConfig<TParams>): Promise<ResponseContent<TData, TResponse>>;

  static extend<Result extends Record<string, any> = Record<string, any>>(instance: NormAxios<Result>, config?: NormAxiosConfig<Result>): NormAxios<Result>;
}

相关类型 ​

NormAxiosConfig ​

NormAxiosInterceptor ​

泛型 ​

名称默认值继承可选描述
TResponseRecord<string, any>Record<string, any>是数据结构类型

构造函数 ​

入参 ​

名称类型默认值描述
configNormAxiosConfig<TResponse>无norm fetch配置;详解

返回值 ​

void

实例-属性 ​

axiosInstance ​

axios 实例

axiosConfig ​

axios 配置

实例-方法 ​

request ​

通用请求方法,与 axios的request用法一致

泛型 ​

名称默认值继承可选描述
TDataany是数据类型
TParamsRecord<string, any>Record<string, any>是接口入参类型

入参 ​

名称类型默认值描述
configAxiosRequestConfig<TResponse>无请求配置;详解

返回值 ​

Promise<ResponseContent<TData,TParams,TResponse>>

示例 ​

typescript
interface Userinfo {
  name: string

  age: number
}

interface UserinfoParams {
  id: number
}

const getUserinfo = (params: UserinfoParams) => server.request<Userinfo, UserinfoParams>({
  url: '/userinfo',
  method: 'get',
  params,
})

get ​

Get请求方法,与 基于request实现，优化了入参方式

泛型 ​

名称默认值继承可选描述
TDataany是数据类型
TParamsRecord<string, any>Record<string, any>是接口入参类型

入参 ​

名称类型默认值描述
urlstring无请求路径
params?TParams无入参
config?AxiosRequestConfig<TResponse>无请求配置;详解

返回值 ​

Promise<ResponseContent<TData,TParams,TResponse>>

示例 ​

typescript
const getUserinfo = (params: UserinfoParams) => server.get('/userinfo', params)

post ​

Post请求方法,与 基于request实现，优化了入参方式

泛型 ​

名称默认值继承可选描述
TDataany是数据类型
TParamsRecord<string, any>Record<string, any>是接口入参类型

入参 ​

名称类型默认值描述
urlstring无请求路径
data?TParams无入参
config?AxiosRequestConfig<TResponse>无请求配置;详解

返回值 ​

Promise<ResponseContent<TData,TParams,TResponse>>

示例 ​

typescript
const getUserinfo = (params: UserinfoParams) => server.post('/userinfo', params)

delete ​

Delete请求方法,与 基于request实现，优化了入参方式

泛型 ​

名称默认值继承可选描述
TDataany是数据类型
TParamsRecord<string, any>Record<string, any>是接口入参类型

入参 ​

名称类型默认值描述
urlstring无请求路径
params?TParams无入参
config?AxiosRequestConfig<TResponse>无请求配置;详解

返回值 ​

Promise<ResponseContent<TData,TParams,TResponse>>

示例 ​

typescript
const getUserinfo = (params: UserinfoParams) => server.delete('/userinfo', params)

put ​

Put请求方法,与 基于request实现，优化了入参方式

泛型 ​

名称默认值继承可选描述
TDataany是数据类型
TParamsRecord<string, any>Record<string, any>是接口入参类型

入参 ​

名称类型默认值描述
urlstring无请求路径
data?TParams无入参
config?AxiosRequestConfig<TResponse>无请求配置;详解

返回值 ​

Promise<ResponseContent<TData,TParams,TResponse>>

示例 ​

typescript
const getUserinfo = (params: UserinfoParams) => server.put('/userinfo', params)

静态-方法 ​

extend ​

使用该静态方法可以继承已有的NormAxios实例

泛型 ​

  • Result：数据结构

入参 ​

名称类型默认值描述
instanceNormAxios<Result>无norm fetch 实例
config？NormAxiosConfig<TResponse>继承实例的配置覆盖norm fetch配置;详解

返回值 ​

NormAxios实例

示例 ​

typescript
import { NormAxios } from 'norm-axios'

const service = new NormAxios({
  baseURL: '/service',
  timeout: 1000,
  interceptor: {
    onBeforeRequest(config) {
      console.log(config)
    },
  },
})

const newService = NormAxios.extend(service, {
  baseURL: '/newService',
})