网络请求

普通请求

import { apiServer } from "@finalx/common";
const user = await apiServer({
  url: APIS.LOGIN,
  data: { userName: "finalx", password: "finalx" }
});

属性名	类型	默认值	必填	描述
requestOptions	RequestOptions	-	否	请求源数据

Hooks

Hooks 基于 taro-hooks 包的基础上进行封装及优化，只做少量的使用改动，基本可以无缝衔接

import { useRequest } from "@finalx/common";
const { data, loading, run } = useRequest(
  { url: APIS.USERS, method: "GET" },
  {} // options
);

入参

属性名	类型	默认值	必填	描述
requestOptions	RequestOptions	-	否	请求源数据
options	Options	-	否	请求配置项

RequestOptions

属性名	类型	默认值	必填	描述
url	string	-	否	请求 URL
data	any	-	否	请求参数
method	string	POST	否	请求方式
coverUrl	string	-	否	覆盖请求 URL

Options

属性名	类型	默认值	必填	描述
refreshDeps	any[]	-	否	刷新的依赖项
manual	boolean	-	否	是否手动触发
onSuccess	()=> any	POST	否	成功回调
onError	()=> any	-	否	失败回调
defaultLoading	boolean	-	否	默认加载
defaultParams	any	-	否	默认参数
ready	boolean	-	否	准备请求的条件

出参

属性名	类型	默认值	必填	描述
data	any	-	否	返回数据
loading	boolean	-	否	加载状态
error	Error | undefined	-	否	错误值
params	any	-	否	请求参数
cancel	(...args: any[]) => void	-	否	取消钩子
refresh	() => Promise<any>	-	否	刷新钩子
mutate	(x: any | undefined | ((data: any) => any)) => void	-	否	手动修改数据钩子
run	(...args: any) => Promise<any>	-	否	手动运行钩子
unmount	() => void	-	否	卸载钩子