# @tanstack/lit-query 中文文档

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

版本：0\.2\.33
npm 元数据更新时间：2026-11-02T13:55:10.494Z
中文译文更新时间：2026-11-02T15:42:47.078Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40tanstack/lit-query
原文对照：https://npmcn.com/package/%40tanstack/lit-query/?lang=original
项目主页：https://tanstack.com/query
源码仓库：https://github.com/TanStack/query

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

- 包体积（解压后）：1 MB，36 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：lit \>=2\.8\.0 \<4
- 首次发布：2026-05-06T09:10:08.291Z
- 最新版本发布：2026-11-02T13:55:10.093Z
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

点亮适配器为TanStack查询核心

## 安装

```sh
npm install @tanstack/lit-query
```

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

## README

![TanStack Lit Query](https://tanstack.com/api/readme/query.png?framework=lit)

\# @tanstack / lit-query

点亮适配器 `@tanstack/query-core` 使用Lit反应控制器。

这个包目前是实验性的，是v0.1。Pin准确的版本，如果你使用 它在生产中，而API是早期的。

## 安装

```bash
npm install @tanstack/lit-query
```

对于此存储库中的本地开发：

```bash
pnpm install
pnpm --dir packages/lit-query run build
```

## 快速入门

```ts
import { LitElement, html } from 'lit'
import {
  QueryClient,
  QueryClientProvider,
  createQueryController,
} from '@tanstack/lit-query'

const client = new QueryClient({
  defaultOptions: { queries: { retry: false } },
})

class AppProvider extends QueryClientProvider {
  constructor() {
    super()
    this.client = client
  }
}
customElements.define('app-provider', AppProvider)

class UsersView extends LitElement {
  private readonly users = createQueryController(this, {
    queryKey: ['users'],
    queryFn: async () => {
      const response = await fetch('/api/users')
      return response.json() as Promise<Array<{ id: string; name: string }>>
    },
  })

  render() {
    const query = this.users()
    if (query.isPending) return html`Loading...`
    if (query.isError) return html`Error`
    return html`<ul>
      ${query.data?.map((u) => html`<li>${u.name}</li>`)}
    </ul>`
  }
}
customElements.define('users-view', UsersView)
```

## API表面

-   `QueryClientProvider`， `useQueryClient`， `resolveQueryClient`
-   `createQueryController`
-   `createMutationController`
-   `createInfiniteQueryController`
-   `createQueriesController`
-   `useIsFetching`， `useIsMutating`， `useMutationState`
-   `queryOptions`， `infiniteQueryOptions`， `mutationOptions`

## 可运行的例子

这个repo在顶层包含了可运行的示例 `examples/lit` 目录，以便它们可以在文档中出现：

-   `examples/lit/basic`： Vite lite应用程序涵盖查询和突变原语。
-   `examples/lit/pagination`：分页、预取、乐观更新和错误恢复。
-   `examples/lit/ssr`：点燃SSR渲染、脱水和水合流动。

从repo的根目录运行一个例子：

```bash
pnpm --dir examples/lit/basic run dev
pnpm --dir examples/lit/pagination run dev
pnpm --dir examples/lit/ssr run dev
```

开放:

-   `http://127.0.0.1:4173/` (基本)
-   `http://127.0.0.1:4183/` （分页示例应用程序）
-   `http://127.0.0.1:4174/` （SSR示例应用）

使用不同的端口（可选）：

```bash
DEMO_PORT=4180 pnpm --dir examples/lit/basic run dev
PAGINATION_DEMO_PORT=4181 PAGINATION_API_PORT=4182 pnpm --dir examples/lit/pagination run dev
SSR_PORT=4180 pnpm --dir examples/lit/ssr run dev
SSR_HOST=0.0.0.0 pnpm --dir examples/lit/ssr run dev
```

## 集成烟

对于在CI中使用的框架构建烟雾：

```bash
pnpm --dir integrations/lit/vite run build
```

## 质量检验关

从存储库根目录：

```bash
pnpm --dir packages/lit-query run test:types
pnpm --dir packages/lit-query run test:lib
pnpm --dir packages/lit-query run build
pnpm --dir packages/lit-query run test:build
```

## 许可证

麻省理工学院

## 常见问题

### @tanstack/lit-query 是什么？

点亮适配器为TanStack查询核心

### 如何安装 @tanstack/lit-query？

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

### @tanstack/lit-query 支持 TypeScript 吗？

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

### @tanstack/lit-query 支持 ESM 还是 CommonJS？

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

### @tanstack/lit-query 可以商用吗？

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

### @tanstack/lit-query 还在维护吗？

最新版本 0\.2\.33 发布于 2026/11/02（今天）；至今共发布 35 个版本，其中过去 12 个月发布了 35 个；首次发布于 2026/05/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。