# @aspida/react-query 中文文档

规范地址：https://npmcn.com/package/%40aspida/react-query/

版本：1\.14\.0
npm 元数据更新时间：2023-10-06T02:38:14.398Z
中文译文更新时间：2026-11-07T08:28:56.574Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aspida/react-query
原文对照：https://npmcn.com/package/%40aspida/react-query/?lang=original
项目主页：https://github.com/aspida/aspida/tree/master/packages/aspida-react-query#readme
源码仓库：https://github.com/aspida/aspida

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：14.3 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：aspida ^1\.14\.0，react-query 
- 首次发布：2021-01-04T16:21:47.320Z
- 最新版本发布：2023-08-15T20:25:38.205Z
- 近 30 天下载量：1984（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 0 个）

## 中文简介

响应 Aspida 的查询包装

## 安装

```sh
npm install @aspida/react-query
```

也可以使用：`pnpm add @aspida/react-query`、`yarn add @aspida/react-query`、`bun add @aspida/react-query`

## README

# @ aspida/ react- query

  
![aspida](https://aspida.github.io/aspida/logos/png/logo.png "aspida")

 [![npm version](https://img.shields.io/npm/v/@aspida/react-query)](https://www.npmjs.com/package/@aspida/react-query)[![npm download](https://img.shields.io/npm/dm/@aspida/react-query)](https://www.npmjs.com/package/@aspida/react-query)

  

[响应查询](https://react-query.tanstack.com/) 包装 [阿斯皮达](https://github.com/aspida/aspida/)。 。 。 .

  
  

## 开始

### 安装

-   使用 [无](https://www.npmjs.com/)数字 :
    
    ```sh
    $ npm install aspida @aspida/react-query @aspida/axios react-query axios
    # $ npm install aspida @aspida/react-query @aspida/fetch react-query
    # $ npm install aspida @aspida/react-query @aspida/node-fetch react-query node-fetch
    ```
    
-   使用 [雅伦](https://yarnpkg.com/)数字 :
    
    ```sh
    $ yarn add aspida @aspida/react-query @aspida/axios react-query axios
    # $ yarn add aspida @aspida/react-query @aspida/fetch react-query
    # $ yarn add aspida @aspida/react-query @aspida/node-fetch react-query node-fetch
    ```
    

### 从应用程序创建 HTTP 请求

`src/index.ts`

```tsx
import aspida from "@aspida/axios"; // "@aspida/fetch", "@aspida/node-fetch"
import { useAspidaQuery } from "@aspida/react-query";
import { QueryClient, QueryClientProvider, useMutation, useQueryClient } from "react-query";
import api from "../api/$api";

const client = api(aspida());
const queryClient = new QueryClient();

function App() {
  return (
    // Provide the client to your App
    <QueryClientProvider client={queryClient}>
      <Todos />
    </QueryClientProvider>
  );
}

function postTodo(body: { id: number; title: string }) {
  return client.todos.$post({ body });
}

function Todos() {
  // Access the client
  const queryClient = useQueryClient();

  // Queries
  const query = useAspidaQuery(client.todos, { query: { limit: 10 } });

  // Mutations
  const mutation = useMutation(postTodo, {
    onSuccess: () => {
      // Invalidate and refetch
      queryClient.invalidateQueries(client.todos.$path({ query: { limit: 10 } }));
    },
  });

  return (
    <div>
      <ul>
        {query.data.map(todo => (
          <li key={todo.id}>{todo.title}</li>
        ))}
      </ul>

      <button
        onClick={() => {
          mutation.mutate({
            id: Date.now(),
            title: "Do Laundry",
          });
        }}
      >
        Add Todo
      </button>
    </div>
  );
}

render(<App />, document.getElementById("root"));
```

### 获得反应机构/状态/负责人

`src/index.ts`

```tsx
import aspida from "@aspida/axios"; // "@aspida/fetch", "@aspida/node-fetch"
import { useAspidaQuery } from "@aspida/react-query";
import { QueryClient, QueryClientProvider } from "react-query";
import api from "../api/$api";

const client = api(aspida());
const queryClient = new QueryClient();

function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <Profile />
    </QueryClientProvider>
  );
}

function Profile() {
  const { data, error } = useAspidaQuery(client.user._userId(123), "get", {
    query: { name: "mario" },
  });

  if (error) return <div>failed to load</div>;
  if (!data) return <div>loading...</div>;
  return (
    <>
      <div>Status: {data.status}</div>
      <div>Headers: {JSON.stringify(data.headers)}</div>
      <div>Name: {data.body.name}</div>
    </>
  );
}

render(<App />, document.getElementById("root"));
```

`useAspidaQuery(client.user._userId(123), { query })` 是一种异名 `useAspidaQuery(client.user._userId(123), "$get", { query })`

### 用回放查询选项

`src/index.ts`

```tsx
import aspida from "@aspida/axios"; // "@aspida/fetch", "@aspida/node-fetch"
import { useAspidaQuery } from "@aspida/react-query";
import { QueryClient, QueryClientProvider } from "react-query";
import api from "../api/$api";

const client = api(aspida());
const queryClient = new QueryClient();

function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <Profile />
    </QueryClientProvider>
  );
}

function Profile() {
  const { data, error } = useAspidaQuery(client.user._userId(123), {
    query: { name: "mario" },
    refetchOnMount: true,
    initialData: { name: "anonymous" },
  });

  if (error) return <div>failed to load</div>;
  return <div>hello {data.name}!</div>;
}

render(<App />, document.getElementById("root"));
```

## 许可证

@aspida/react-query根据 [MIT 许可证](https://github.com/aspida/aspida/blob/master/packages/aspida-react-query/LICENSE)。 。 。 .

## 常见问题

### @aspida/react-query 是什么？

响应 Aspida 的查询包装

### 如何安装 @aspida/react-query？

在项目目录运行 npm install @aspida/react-query，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：aspida（^1\.14\.0）、react-query（）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aspida/react-query 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aspida/react-query 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @aspida/react-query 可以商用吗？

@aspida/react-query 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aspida/react-query 的下载量有多少？

根据 npm 官方下载统计，@aspida/react-query 在 2026/10/07 – 2026/11/05 这 30 天内被下载 1,984 次，日均约 66 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aspida/react-query 还在维护吗？

最新版本 1\.14\.0 发布于 2023/08/16（3 年前）；至今共发布 27 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/01/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。