@apollo/client-integration-tanstack-start

中文文档
0.14.5-rc.0发布于 2026/04/09MITTypeScriptESM + CJS构建来源已验证近 30 天下载 6.9万

这个软件包提供阿波罗客户端和TanStack Start之间的集成,支持现代流传的SS.

中文使用文档
文档目录5 节
  1. 阿波罗客户端技能
  2. 设置
  3. 使用量
  4. loader 与 preloadQuery 财务报告和审定财务报表 useReadQuery
  5. useSuspenseQuery

@ apollo/ 客户端- 整合- tanstack- start

这个软件包提供阿波罗客户端和TanStack Start之间的集成,支持现代流传的SS.

阿波罗客户端技能

给予你的AI特工阿波罗专业客户端知识和设置指导:

npx skills add apollographql/skills --skill apollo-client

设置

安装依赖性 :

npm i @apollo/client-integration-tanstack-start @apollo/client graphql

在你身边 routes/__root.tsx,从 createRootRoute 改为 createRootRouteWithContext 为您的应用程序提供正确的上下文类型.

+import type { ApolloClientIntegration } from "@apollo/client-integration-tanstack-start";
import {
-   createRootRoute
+   createRootRouteWithContext
} from "@tanstack/react-router";

-export const Route = createRootRoute({
+export const Route = createRootRouteWithContext<ApolloClientIntegration.RouterContext>()({

在你身边 router.tsx,设置您的阿波罗客户端实例并运行 routerWithApolloClient

import {
  routerWithApolloClient,
  ApolloClient,
  InMemoryCache,
} from "@apollo/client-integration-tanstack-start";
import { HttpLink } from "@apollo/client";
import { createRouter } from "@tanstack/react-router";
import { routeTree } from "./routeTree.gen";

export function getRouter() {
  const apolloClient = new ApolloClient({
    cache: new InMemoryCache(),
    link: new HttpLink({ uri: "https://your.graphql.api" }),
  });
  const router = createTanStackRouter({
    routeTree,
    context: {
      ...routerWithApolloClient.defaultContext,
    },
  });

  return routerWithApolloClient(router, apolloClient);
}

[大
ApolloClient 财务报告和审定财务报表 InMemoryCache 需要从 @apollo/client-integration-tanstack-start,而不是从 @apollo/client。 。 。 .

使用量

loader 与 preloadQuery 财务报告和审定财务报表 useReadQuery

import { useReadQuery } from "@apollo/client";
import { createFileRoute } from "@tanstack/react-router";

export const Route = createFileRoute("/loader-defer")({
  component: RouteComponent,
  loader: ({ context: { preloadQuery } }) => {
    const queryRef = preloadQuery(QUERY, {
      variables: { myVariable: "myValue" },
    });
    return {
      queryRef,
    };
  },
});

function RouteComponent() {
  const { queryRef } = Route.useLoaderData();
  const { data } = useReadQuery(queryRef);

  return (
    <div> do something with `data` here </div>
  )
}

useSuspenseQuery

也可以使用悬念的阿波罗客户端 api useSuspenseQuery (或 useQueryRef 财务报告和审定财务报表 useReadQuery直接进入组件而无需加载器:

import { useSuspenseQuery } from "@apollo/client";
import { createFileRoute } from "@tanstack/react-router";

export const Route = createFileRoute("/myPage")({
  component: RouteComponent,
});

function RouteComponent() {
  const { data } = useSuspenseQuery(QUERY);

  return <div> do something with `data` here </div>;
}

版本与发布记录

@apollo/client-integration-tanstack-start 共发布 11 个版本,首次发布于 2025/02/13;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.14.5-rc.0latest2026/04/096 个月前
0.14.4-rc.02026/01/079 个月前
0.14.3-rc.02025/12/1810 个月前
0.14.2-rc.02025/12/1610 个月前
0.14.0-rc.02025/10/131.1 年前
0.12.3-alpha.52025/05/051.5 年前

其他发布通道:alpha → 0.12.0-alpha.0。

关于 @apollo/client-integration-tanstack-start 的常见问题

@apollo/client-integration-tanstack-start 是什么?

这个软件包提供阿波罗客户端和TanStack Start之间的集成,支持现代流传的SS.

如何安装 @apollo/client-integration-tanstack-start?

在项目目录运行 npm install @apollo/client-integration-tanstack-start,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@apollo/client(^4.0.0)、@tanstack/react-router(^1.132.47)、@tanstack/react-start(^1.132.48)、@tanstack/router-core(^1.132.47)、graphql(^16 || >=17.0.0-alpha.2)、react(^19)、react-dom(^19)、rxjs(^7.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@apollo/client-integration-tanstack-start 支持 TypeScript 吗?

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

@apollo/client-integration-tanstack-start 支持 ESM 还是 CommonJS?

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

@apollo/client-integration-tanstack-start 可以商用吗?

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

@apollo/client-integration-tanstack-start 的下载量有多少?

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

@apollo/client-integration-tanstack-start 还在维护吗?

最新版本 0.14.5-rc.0 发布于 2026/04/09(6 个月前);至今共发布 11 个版本,其中过去 12 个月发布了 4 个;首次发布于 2025/02/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。