Skip to Content
ToolsRequest Builder

Request Builder

基于 react-query常用的 hook 封装的 api code gen runtime,提供如下能力:

example

// 一般情况下,这些代码是通过 api code gen 工具生成的 export const coinsPostApi = new RequestBuilder< coinsPostApi.Req, coinsPostApi.Res >({ url: "/coins", method: "post", });

普通 promise 调用,不走 react-query 的缓存

const res = await coinsPostApi.request(); // do something console.log(res);

hooks 调用,走 react-query 的缓存

const { data } = coinsPostApi.useQuery(); // or const {} = coinsPostApi.useMutation(); // or 分页能力 const {} = coinsPostApi.useInfiniteQuery();

支持 react-query 的能力

coinsPostApi.prefetchQuery(); coinsPostApi.fetchQuery(); coinsPostApi.invalidateQuery(); coinsPostApi.refetchQueries(); coinsPostApi.getQueryData(); coinsPostApi.setQueryData(); coinsPostApi.ensureQueryData();