@liangskyli/request v0.1.0

通用请求库@liangskyli/request

基于@liangskyli/request库可以二次封装多端请求库，支持中间件插件。

• 支持多端请求库的二次封装
  • http client
  • nodes
  • taro小程序
• 请求库的二次封装示例可看@liangskyli/axios-request

安装:

pnpm add @liangskyli/request

使用

createRequest函数

• 对第三方请求库的二次封装，如axios

import { createRequest } from '@liangskyli/request';
import type { AxiosRequestConfig } from 'axios';
import axios from 'axios';

const request = (config: AxiosRequestConfig) => axios.create().request(config);
type IF = typeof request;
export const axiosCreateRequest = <
  IC extends FirstParamType<IF> = FirstParamType<IF>,
  IR = PromiseReturnType<IF>,
>(
  initConfig?: Partial<IC>,
) => createRequest<IF, IC, IR>(request, initConfig);

• createRequest返回值可以设置请求和响应中间件

import { createRequest } from '@liangskyli/request';

const createRequestObj = createRequest(request, initConfig);
createRequestObj.middlewares.request.use(中间件函数);
createRequestObj.middlewares.response.use(中间件函数);

通用中间件

1、加载中间件

• loadingMiddleware 函数类型

(option: LoadingConfig) => Middleware<Context<LoadingOption>>

• loadingMiddleware 函数入参属性

• LoadingConfig属性

• LoadingOption 属性
  • 中间件回调函数里的参数，可以用于指定接口设置加载中间件是否启用(customOptions.loadingEnabled)

• LoadingOption.customOptions 属性

2、序列化响应数据中间件

• 功能是把接口响应数据序列化为object对象的格式

  • 默认成功数据序列化格式,如果成功响应string数据，会自动转为object对象，成功数据放入data里

  {
    retCode: '0',
    data: {},// 成功响应string数据时，会自动处理为 data:'响应string数据'
    // 其它字段不处理，如：retMsg
  }

• serializedResponseMiddleware 函数类型

(option: SerializedResponseConfig) => Middleware<Context>

• serializedResponseMiddleware 函数入参属性

• SerializedResponseConfig 属性

3、序列化错误中间件

• serializedErrorMiddleware 函数类型

<
  CodeKey extends string,
  MessageKey extends string,
>(
   option: SerializedErrorConfig<CodeKey, MessageKey>,
) => Middleware<Context>

• serializedErrorMiddleware 函数入参属性

• SerializedErrorConfig 属性

• messageMap 默认映射表规则，可以配置messageMap覆盖默认映射规则，或加额外规则

{
  ['Network Error']: '网络错误，请检查网络配置',
  ['ECONNABORTED']: '网络超时，请稍后再试',
  // for taro
  ['request:fail']: '网络错误，请检查网络配置',
  ['request:fail timeout']: '网络超时，请稍后再试',
  ...messageMap,
}

4、显示错误提示中间件

• showErrorMiddleware 函数类型

(
  option: ShowErrorConfig,
) => Middleware<Context<ShowErrorOption>>

• showErrorMiddleware 函数入参属性

• ShowErrorConfig 属性

• ShowErrorOption 属性
  • 中间件回调函数里的参数，可以用于指定接口设置显示错误中间件是否启用(customOptions.showErrorEnabled)

• LoadingOption.customOptions 属性

composeMiddleware函数

• 合并中间件,多个中间件合并
• 类型

<T>(
  middleware: Array<Middleware<T>>,
) => ComposedMiddleware<T>