@longzai-intelligence-transport/http-adapter-react
v0.2.0
Published
Maintainers
Readme
@longzai-intelligence-transport/http-adapter-react
React Hooks 适配器,基于 SWR 提供类型安全的 Query、Mutation、Infinite Hook 工厂。
安装
bun add @longzai-intelligence-transport/http-adapter-react功能特性
- Query Hook 工厂 - 创建类型安全的数据查询 Hook
- Mutation Hook 工厂 - 创建类型安全的数据变更 Hook
- Infinite Hook 工厂 - 创建类型安全的无限滚动 Hook
- 完整的 TypeScript 支持 - 自动推断参数和返回类型
依赖
react- React 框架(peer dependency,>=18.0.0)swr- SWR 数据请求库(peer dependency,>=2.0.0)zod- Schema 验证(peer dependency)@longzai-intelligence-transport/http-core- 核心模块
使用示例
Query Hook
import { createQueryHook } from '@longzai-intelligence-transport/http-adapter-react';
const useGetUser = createQueryHook(getUserApi, 'user');
const { data, error, isLoading } = useGetUser({ id: '123' });Mutation Hook
import { createMutationHook } from '@longzai-intelligence-transport/http-adapter-react';
const useCreateUser = createMutationHook(createUserApi);
const { trigger, isMutating } = useCreateUser();
await trigger({ body: { name: 'John' } });Infinite Hook
import { createInfiniteHook } from '@longzai-intelligence-transport/http-adapter-react';
const useUserList = createInfiniteHook(getUserListApi);
const { data, size, setSize, isLoadingMore } = useUserList();导出模块
Query Hook
createQueryHook- 创建查询 Hook 工厂函数QueryHookFunction- 查询 Hook 函数类型QueryHookReturn- 查询 Hook 返回类型QueryHookNoParams- 无参数查询 Hook 类型QueryHookWithParams- 带路径参数查询 Hook 类型QueryHookWithQuery- 带查询参数 Hook 类型QueryHookWithParamsAndQuery- 带路径和查询参数 Hook 类型
Mutation Hook
createMutationHook- 创建变更 Hook 工厂函数MutationHookFunction- 变更 Hook 函数类型MutationHookReturn- 变更 Hook 返回类型MutationTriggerArgs- 触发器参数类型MutationTriggerNoArgs- 无参数触发器类型MutationTriggerWithParams- 带路径参数触发器类型MutationTriggerWithBody- 带请求体触发器类型MutationTriggerWithParamsAndBody- 带路径参数和请求体触发器类型
Infinite Hook
createInfiniteHook- 创建无限滚动 Hook 工厂函数InfiniteHookFunction- 无限滚动 Hook 函数类型InfiniteHookReturn- 无限滚动 Hook 返回类型ExtractPageItem- 提取分页项类型
许可证
UNLICENSED
